Preview

Badge

Controls

Variant

Size

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Options

Visual options rendered from the current preview target.

Variant

Default

Secondary

Destructive

Success

Warning

Info

Outline

Ghost

Size

Sm

Md

Lg

Installation

terminal

php artisan ui:add badge

Registry contract

Install confidence

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

Type	Generated target
blade	resources/views/components/ui/badge.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Compact label and metadata

Communicate concise status, count, or metadata.

Use when

Use for compact labels, counts, and concise metadata that support scanning. Do not force badges or short labels to carry complex explanations that need sentence-level context.

Avoid when

Avoid using badge 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 explanatory text

Anti-patterns

Encoding complex meaning in a badge alone

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
variant	default\|secondary\|destructive\|success\|warning\|info\|outline	default	Badge tone.
size	sm\|md\|lg	md	Documented catalog control used by the preview workbench.

Slots

default — Badge label or inline icon/text content.

Data slots

badge badge-label

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Inline display primitive with no JavaScript behavior.
Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.badge.default.blade.php Blade

<x-ui.badge>{{ __('Badge') }}</x-ui.badge>

Variants

Default Secondary Destructive Success Warning Info Outline Ghost

previews.components.badge.variants.blade.php Blade

<div class="flex flex-wrap items-center gap-2">
    <x-ui.badge>{{ __('Default') }}</x-ui.badge>
    <x-ui.badge variant="secondary">{{ __('Secondary') }}</x-ui.badge>
    <x-ui.badge variant="destructive">{{ __('Destructive') }}</x-ui.badge>
    <x-ui.badge variant="success">{{ __('Success') }}</x-ui.badge>
    <x-ui.badge variant="warning">{{ __('Warning') }}</x-ui.badge>
    <x-ui.badge variant="info">{{ __('Info') }}</x-ui.badge>
    <x-ui.badge variant="outline">{{ __('Outline') }}</x-ui.badge>
    <x-ui.badge variant="ghost">{{ __('Ghost') }}</x-ui.badge>
</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.1.1. See the site changelog for the full release history.