Skip to content
UI Brok

Loading…

No results

Browse catalog

Kbd

Displays a keyboard key or key combination.

Preview

Press K to open the command menu.

Controls

Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal
php artisan ui:add kbd

Registry contract

Install confidence

php artisan ui:add kbd writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/kbd.blade.php
blade resources/views/components/ui/kbd/group.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Scannable data display

Present data for rapid scanning.

Use when

  • Use to summarize, sequence, or present data so users can scan it quickly. Do not add display-only ornament when the user needs actionable structure or exact comparison instead.

Avoid when

  • Avoid using kbd as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
short
Interaction cost
low
Interruptiveness
none
Input precision
none
Mobile / touch risk
low
Accessibility risk
medium
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • Table for exact comparison
  • Plain text for a single value

Anti-patterns

  • Adding display ornament without informational value

API

manifest knowledge + registry-derived coverage

Props

No documented props. Pass normal Blade attributes through the component root.

Slots

  • default — Primary Blade slot rendered by the component.
  • x-ui.kbd.group — Installed subcomponent from the registry item.

Data slots

kbd kbd-group

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.kbd.default.blade.php Blade
<p class="text-sm text-muted-foreground">
    {{ __('Press') }}
    <x-ui.kbd.group>
        <x-ui.kbd>⌘</x-ui.kbd>
        <x-ui.kbd>K</x-ui.kbd>
    </x-ui.kbd.group>
    {{ __('to open the command menu.') }}
</p>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/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 above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.