Skip to content
Brok UI

Loading…

No results

Token

Open source

tokenui.dev-inspired design-token documentation chips — a base name → value token with click-to-copy, plus typed variants for colour, typography, dimension, motion and scalar tokens.

Version
v1.1.1
Stability
stable
License
MIT
Related
Token
Color Token
Typography Token
Font Family Token
Font Weight Token
Spacing Token
Radius Token
Elevation Token
Duration Token
Order Token
10 of 11

Number Token — Documents a single unitless numeric design token (opacity, line-height, scale, …) — a numeric glyph badge plus the token name, with the numeric value revealed in a tooltip on hover and click-to-copy.

Preview

leading-normal 1.5 opacity-disabled 0.5 scale-zoom 1.05 line-height-tight 1.25
Side
previews.components.number-token.default.blade.php Blade
<div class="flex flex-wrap items-center gap-3">
    <x-ui.number-token name="leading-normal" value="1.5" />
    <x-ui.number-token name="opacity-disabled" value="0.5" />
    <x-ui.number-token name="scale-zoom" value="1.05" />
    <x-ui.number-token name="line-height-tight" value="1.25" />
</div>
Top Current
Right Current
Bottom Current
Left Current

Installation

terminal
php artisan ui:add number-token

Registry contract

php artisan ui:add number-token writes only the files below. The CLI validates each file hash before writing and asks before it replaces a local change, unless you pass --force.

  • blade resources/views/components/ui/number-token.blade.php
Registry dependencies
token
Packages
composer: jml/brok:^0.2

Use with AI

A brief for your coding agent: install command, usage, props, guidance and the rules. Copy it, or open a prompt about this component in an assistant.

number-token.md
# Brok UI: Number Token (`number-token`)

Documents a single unitless numeric design token (opacity, line-height, scale, …) — a numeric glyph badge plus the token name, with the numeric value revealed in a tooltip on hover and click-to-copy.

Brok UI is a Laravel Blade component registry. Installed components are plain Blade files the app owns.

## Install

```bash
php artisan ui:add number-token
```

## Usage

```blade
<div class="flex flex-wrap items-center gap-3">
    <x-ui.number-token name="leading-normal" value="1.5" />
    <x-ui.number-token name="opacity-disabled" value="0.5" />
    <x-ui.number-token name="scale-zoom" value="1.05" />
    <x-ui.number-token name="line-height-tight" value="1.25" />
</div>
```

## Props

- `name` (string, default ``) — Token name shown as the chip label and tooltip trigger.
- `value` (string, default ``) — Token numeric value, shown in the tooltip and copied to the clipboard.
- `copyable` (bool, default `true`) — Shows the copy button when true.
- `side` (string, default `top`) — Tooltip placement side.

## Use when

- Use to document, inspect, and apply design-system decisions consistently across teams and AI tooling.
- Documenting a unitless numeric token, such as an opacity, line-height or scale value.
- Listing numeric tokens in a style guide where a generic badge is enough to mark the value as a number.

## Avoid when

- Do not present token-level controls to end users who only need product functionality.
- Documenting a token with a typed visual meaning (colour, spacing, radius, …); use the matching specialised token component instead, which renders a truer preview.

## Anti-patterns

- Exposing implementation tokens as product settings

## Rules

- Use the `<brok:number-token>` tag (or `<x-ui.number-token>`) in Blade; do not rewrite the component.
- Prefer the documented props and variants over utility-class overrides; when a utility must win, use the `!` important modifier.
- Use semantic design tokens (`bg-primary`, `text-muted-foreground`), never raw colour utilities.
- Keep the `data-slot` attributes; they are the styling and test hooks.

## Links

- Docs: https://brokui.dev/docs/components/number-token
- Registry JSON (files, props, contract): https://brokui.dev/r/open/number-token.json

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

API

manifest knowledge + registry-derived coverage

Props

Props accepted by this component: name, type, default value and description.
Prop Type Default Description
name string Token name shown as the chip label and tooltip trigger.
value string Token numeric value, shown in the tooltip and copied to the clipboard.
copyable bool true Shows the copy button when true.
side string top Tooltip placement side.

Slots

  • default — Extra content appended inside the chip.

Data slots

Stable hooks for CSS overrides and browser tests.

number-token

Behavior

  • Composes the base token chip and supplies a static "#" glyph badge as the indicator, since a unitless number has no visual form to preview.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Guidance

Design-token documentation

Inspect and govern design-system decisions.

Use when

  • Use to document, inspect, and apply design-system decisions consistently across teams and AI tooling.
  • Documenting a unitless numeric token, such as an opacity, line-height or scale value.
  • Listing numeric tokens in a style guide where a generic badge is enough to mark the value as a number.

Avoid when

  • Do not present token-level controls to end users who only need product functionality.
  • Documenting a token with a typed visual meaning (colour, spacing, radius, …); use the matching specialised token component instead, which renders a truer preview.

Use instead

  • Product-level controls for end users

Anti-patterns

  • Exposing implementation tokens as product settings
Anatomy
root
Theming hooks
number-token

Accessibility

WCAG 2.2 AA Keyboard focus-visible RTL-ready Localized labels Dark mode
Keyboard
No component-owned keyboard interaction; native element behavior applies.
Focus
none
  • The badge glyph is decorative and aria-hidden; the token name and tooltip carry the numeric value.
  • Semantic HTML and a stable data-slot attribute for styling and scripting hooks.
  • Focus-visible rings use the ring token, so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces in the preview.
  • Labels go through __() and layout uses logical properties (ms-*, text-start), so it mirrors under dir="rtl" — flip the preview to RTL to confirm.
  • Dark mode uses the same semantic tokens under the dark class; high contrast follows forced-color system tokens.

Livewire

Safe

Livewire can update this component through forwarded wire:* attributes.

Source

The exact, editable file ui:add writes into your app. Previews render this same code; there are no preview-only components.

resources/views/components/ui/number-token.blade.php Blade
@props([
    'name' => '',
    'value' => '',
    'copyable' => true,
    'side' => 'top',
])

{{--
    Number Token (tokenui.dev-inspired) — documents a single unitless numeric
    design token (opacity, line-height, scale, …). A numeric glyph badge plus the
    token name; the numeric value is revealed in a tooltip on hover/focus and
    copied with one click. Implements the `number` type from the W3C Design
    Tokens spec. Composes the base `token` chip and supplies the badge through
    its `indicator` slot.
--}}

<x-ui.token
    data-slot="number-token"
    :name="$name"
    :value="$value"
    :copyable="$copyable"
    :side="$side"
    {{ $attributes }}
>
    <x-slot:indicator>
        <span class="flex size-4 items-center justify-center rounded bg-muted font-mono text-2xs font-semibold text-muted-foreground">#</span>
    </x-slot:indicator>
</x-ui.token>

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.1.1
Status
Stable
License
open
Accessibility reviewed
No review date recorded
Last breaking change
No date recorded
Deprecation
Not deprecated
Contract
v6
Foundation
≥ 1.0.0