Skip to content
UI Brok

Loading…

No results

Browse catalog

Badge Overflow

Renders a list of badges and collapses any overflow into a compact +N badge.

Preview

React Vue Svelte 2 more

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 badge-overflow

Registry contract

Install confidence

php artisan ui:add badge-overflow 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/badge-overflow.blade.php

Registry dependencies

badge

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-overflow 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
Related: badge

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
items array [] Declared by @props in the registry Blade source.
max int 3 Declared by @props in the registry Blade source.
variant string secondary Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

badge-overflow badge-overflow-more

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.badge-overflow.default.blade.php Blade 
<x-ui.badge-overflow :items="['React','Vue','Svelte','Angular','Solid']" :max="3" />

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.