Preview

Button

Prop	Type	Default	Description
`variant`	`'default' \| 'outline' \| 'ghost'`	`default`	Visual style of the button.
`size`	`'sm' \| 'md' \| 'lg'`	`md`	Control height and padding.
`disabled`	`boolean`	`false`	Prevent interaction and dim the control.
`href`*	`string`	`—`	Render as a link to this destination.

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 api-reference-table

Registry contract

Install confidence

php artisan ui:add api-reference-table 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/api-reference-table.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Developer and documentation tool

Expose exact technical or diagnostic information.

Use when

Use for exact technical detail, code readability, diagnostics, and copyable reference material. Do not surface developer-specific patterns in end-user flows unless the task genuinely requires them.

Avoid when

Avoid using api-reference-table 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: medium
Interaction cost: medium
Interruptiveness: none
Input precision: precise
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Plain-language product UI for nontechnical users

Anti-patterns

Exposing developer tooling in end-user flows without a task need

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
title	mixed\|null	null	Declared by @props in the registry Blade source.
props	array	[]	Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

api-reference-table

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.api-reference-table.default.blade.php Blade

<x-ui.api-reference-table
    title="Button"
    :props="[
        ['name' => 'variant', 'type' => '\'default\' | \'outline\' | \'ghost\'', 'default' => 'default', 'description' => 'Visual style of the button.'],
        ['name' => 'size', 'type' => '\'sm\' | \'md\' | \'lg\'', 'default' => 'md', 'description' => 'Control height and padding.'],
        ['name' => 'disabled', 'type' => 'boolean', 'default' => 'false', 'description' => 'Prevent interaction and dim the control.'],
        ['name' => 'href', 'type' => 'string', 'required' => true, 'description' => 'Render as a link to this destination.'],
    ]"
/>

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.

API Reference Table