Preview

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 navigation-menu

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './navigation-menu.js';

Registry contract

Install confidence

php artisan ui:add navigation-menu 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.1.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/navigation-menu.blade.php
blade	resources/views/components/ui/navigation-menu/list.blade.php
blade	resources/views/components/ui/navigation-menu/item.blade.php
blade	resources/views/components/ui/navigation-menu/trigger.blade.php
blade	resources/views/components/ui/navigation-menu/content.blade.php
blade	resources/views/components/ui/navigation-menu/link.blade.php
js	resources/js/ui/navigation-menu.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Navigation and orientation

Orient users and move between destinations.

Use when

Use to orient users and help them move across pages, sections, or commands. Do not hide primary wayfinding in novelty interactions or deep nested structures if straightforward navigation would be clearer.

Avoid when

Avoid using navigation-menu 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: low
Interruptiveness: none
Input precision: none
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Visible links and local navigation

Anti-patterns

Hiding primary wayfinding in novelty interactions

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
href	string	#	Declared by @props in the registry Blade source.

Slots

default — Compose list, item, trigger, content, and link subcomponents.
x-ui.navigation-menu.list — Installed subcomponent from the registry item.
x-ui.navigation-menu.item — Installed subcomponent from the registry item.
x-ui.navigation-menu.trigger — Installed subcomponent from the registry item.
x-ui.navigation-menu.content — Installed subcomponent from the registry item.
x-ui.navigation-menu.link — Installed subcomponent from the registry item.

Data slots

navigation-menu navigation-menu-content navigation-menu-item navigation-menu-link navigation-menu-list navigation-menu-trigger

Capabilities

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

Behavior

Uses server-rendered Blade and semantic HTML.
Opens content panels on hover or focus and closes on Escape or pointer leave delay.
Designed for site navigation with keyboard-reachable triggers and links.
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.navigation-menu.default.blade.php Blade

<x-ui.navigation-menu>
    <x-ui.navigation-menu.list>
        <x-ui.navigation-menu.item>
            <x-ui.navigation-menu.trigger>{{ __('Products') }}</x-ui.navigation-menu.trigger>
            <x-ui.navigation-menu.content>
                <x-ui.navigation-menu.link href="#">{{ __('Analytics') }}</x-ui.navigation-menu.link>
                <x-ui.navigation-menu.link href="#">{{ __('Automation') }}</x-ui.navigation-menu.link>
                <x-ui.navigation-menu.link href="#">{{ __('Integrations') }}</x-ui.navigation-menu.link>
            </x-ui.navigation-menu.content>
        </x-ui.navigation-menu.item>
        <x-ui.navigation-menu.item>
            <x-ui.navigation-menu.trigger>{{ __('Company') }}</x-ui.navigation-menu.trigger>
            <x-ui.navigation-menu.content>
                <x-ui.navigation-menu.link href="#">{{ __('About') }}</x-ui.navigation-menu.link>
                <x-ui.navigation-menu.link href="#">{{ __('Careers') }}</x-ui.navigation-menu.link>
            </x-ui.navigation-menu.content>
        </x-ui.navigation-menu.item>
    </x-ui.navigation-menu.list>
</x-ui.navigation-menu>

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

Navigation Menu