Skip to content
UI Brok

Loading…

No results

Browse catalog

Dropdown Menu

Menu with keyboard navigation, click-outside dismissal and Escape handling.

Preview

Controls

Disabled
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 dropdown

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/dropdown.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS
import './dropdown.js';

Registry contract

Install confidence

php artisan ui:add dropdown 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.2.2
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/dropdown.blade.php
blade resources/views/components/ui/dropdown/trigger.blade.php
blade resources/views/components/ui/dropdown/content.blade.php
blade resources/views/components/ui/dropdown/item.blade.php
blade resources/views/components/ui/dropdown/label.blade.php
blade resources/views/components/ui/dropdown/separator.blade.php
blade resources/views/components/ui/dropdown/shortcut.blade.php
blade resources/views/components/ui/dropdown/group.blade.php
blade resources/views/components/ui/dropdown/checkbox-item.blade.php
blade resources/views/components/ui/dropdown/radio-group.blade.php
blade resources/views/components/ui/dropdown/radio-item.blade.php
blade resources/views/components/ui/dropdown/submenu.blade.php
blade resources/views/components/ui/dropdown/sub-trigger.blade.php
blade resources/views/components/ui/dropdown/sub-content.blade.php
js resources/js/ui/dropdown.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Secondary action menu

Provide compact access to secondary actions.

Use when

  • Use for secondary actions when compact access is more important than constant visibility. Do not hide the most frequent or highest-value actions in a menu when discoverability matters.

Avoid when

  • Avoid using dropdown 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
micro
Interaction cost
medium
Interruptiveness
none
Input precision
none
Mobile / touch risk
medium
Accessibility risk
high
Needs background context
Yes
Comparison needed
No

Preferred alternatives

  • Visible button for frequent actions
  • Inline action bar

Anti-patterns

  • Hiding primary actions in menus

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
align string start Declared by @props in the registry Blade source.
href mixed|null null Declared by @props in the registry Blade source.
label mixed|null null Declared by @props in the registry Blade source.
checked bool false Declared by @props in the registry Blade source.

Slots

  • default — Compose trigger, content, item, label, and separator subcomponents.
  • x-ui.dropdown.trigger — Installed subcomponent from the registry item.
  • x-ui.dropdown.content — Installed subcomponent from the registry item.
  • x-ui.dropdown.item — Installed subcomponent from the registry item.
  • x-ui.dropdown.label — Installed subcomponent from the registry item.
  • x-ui.dropdown.separator — Installed subcomponent from the registry item.
  • x-ui.dropdown.shortcut — Installed subcomponent from the registry item.
  • x-ui.dropdown.group — Installed subcomponent from the registry item.
  • x-ui.dropdown.checkbox-item — Installed subcomponent from the registry item.
  • x-ui.dropdown.radio-group — Installed subcomponent from the registry item.
  • x-ui.dropdown.radio-item — Installed subcomponent from the registry item.
  • x-ui.dropdown.submenu — Installed subcomponent from the registry item.
  • x-ui.dropdown.sub-trigger — Installed subcomponent from the registry item.
  • x-ui.dropdown.sub-content — Installed subcomponent from the registry item.

Data slots

dropdown dropdown-checkbox-item dropdown-content dropdown-group dropdown-item dropdown-label dropdown-radio-group dropdown-radio-item dropdown-separator dropdown-shortcut dropdown-sub-content dropdown-sub-trigger dropdown-submenu dropdown-trigger

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Supports roving keyboard navigation, Escape dismissal, outside click dismissal, and focus restoration.
  • Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
  • Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.dropdown.default.blade.php Blade
<x-ui.dropdown>
    <x-ui.dropdown.trigger class="inline-flex h-10 items-center justify-center gap-2 rounded-md border border-border bg-background px-4 text-sm font-medium text-foreground transition-colors hover:bg-muted focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background">
        {{ __('Options') }}
        <svg aria-hidden="true" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="size-4"><path d="m6 9 6 6 6-6" /></svg>
    </x-ui.dropdown.trigger>

    <x-ui.dropdown.content>
        <x-ui.dropdown.label>{{ __('My Account') }}</x-ui.dropdown.label>
        <x-ui.dropdown.item>{{ __('Profile') }}</x-ui.dropdown.item>
        <x-ui.dropdown.item>{{ __('Billing') }}</x-ui.dropdown.item>
        <x-ui.dropdown.item>{{ __('Settings') }}</x-ui.dropdown.item>
        <x-ui.dropdown.separator />
        <x-ui.dropdown.item>{{ __('Sign out') }}</x-ui.dropdown.item>
    </x-ui.dropdown.content>
</x-ui.dropdown>

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.2.2. See the site changelog for the full release history.