Preview

Built entirely with the badge primitive — hover or focus the link to preview it.

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 component-preview-tooltip

Registry contract

Install confidence

php artisan ui:add component-preview-tooltip 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/component-preview-tooltip.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Contextual overlay

Show lightweight contextual details or actions.

Use when

Use for lightweight contextual details or actions near a trigger. Do not use for long content, required reading, or complex interaction flows.

Avoid when

Avoid using component-preview-tooltip 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: low
Input precision: none
Mobile / touch risk: high
Accessibility risk: high
Needs background context: Yes
Comparison needed: No

Preferred alternatives

Inline disclosure
Sheet or page for longer content

Anti-patterns

Required reading in a popover
Complex forms in fragile anchored overlays

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
label	mixed\|null	null	Declared by @props in the registry Blade source.
description	mixed\|null	null	Declared by @props in the registry Blade source.
side	string	top	Declared by @props in the registry Blade source.

Slots

default — Primary Blade slot rendered by the component.

Data slots

component-preview-tooltip

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.component-preview-tooltip.default.blade.php Blade

<div class="mx-auto max-w-md py-10 text-center text-sm text-foreground">
    Built entirely with the
    <x-ui.component-preview-tooltip
        label="Badge"
        description="A small status pill with token-themed variants."
        side="top"
    >
        <span class="font-medium text-primary">badge</span>
        <x-slot:preview>
            <span class="flex gap-1.5">
                <x-ui.badge>Default</x-ui.badge>
                <x-ui.badge variant="success">Live</x-ui.badge>
            </span>
        </x-slot:preview>
    </x-ui.component-preview-tooltip>
    primitive — hover or focus the link to preview it.
</div>

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.

Component Preview Tooltip