Preview

composer require jml/brok

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 copy-button

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './copy-button.js';

Registry contract

Install confidence

php artisan ui:add copy-button 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.1
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/copy-button.blade.php
js	resources/js/ui/copy-button.js

Registry dependencies

button

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Buttons and direct actions

Commit an explicit user action.

Use when

Use for explicit actions and commits; keep one action visually primary when several sit together. Do not use button treatment for navigation-only view changes when links, tabs, or radios describe state more clearly.

Avoid when

Avoid using copy-button 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: precise
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Link for navigation
Tabs or radios for view changes

Anti-patterns

Using a button for navigation-only state changes
Presenting multiple equally dominant primary actions

Related: button

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
value	string		Declared by @props in the registry Blade source.
timeout	int	2000	Declared by @props in the registry Blade source.
label	string	Copy	Declared by @props in the registry Blade source.
copiedLabel	string	Copied	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

copy-button

Capabilities

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

Behavior

Uses server-rendered Blade and semantic HTML.
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.copy-button.default.blade.php Blade

<div class="flex items-center gap-3 rounded-md border border-border bg-muted px-4 py-3 font-mono text-sm text-foreground">
    <span class="flex-1">composer require jml/brok</span>
    <x-ui.copy-button value="composer require jml/brok" label="Copy command" :copiedLabel="__('Copied')" />
</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.1. See the site changelog for the full release history.

Copy Button