Preview

Storage 3,200 / 8,000

Storage 7,600 / 8,000

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 usage-meter

Registry contract

Install confidence

php artisan ui:add usage-meter 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: 2.0.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/usage-meter.blade.php

Registry dependencies

progress

Package dependencies

composer: jml/brok:^1.0

Guidance

Chart and visual analytics

Reveal a visual trend, distribution, flow, or relationship.

Use when

Use when trend, distribution, flow, intensity, or relationship questions are easier to answer visually than in raw numbers. Do not use a chart when users mainly need exact lookup or when a single metric would be clearer as text or a stat.

Avoid when

Avoid using usage-meter 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: none
Mobile / touch risk: high
Accessibility risk: high
Needs background context: No
Comparison needed: Yes

Preferred alternatives

Table for exact lookup
Stat for a single value

Anti-patterns

Decorative charts without a meaningful question

Related: progress

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
used	int	340	Declared by @props in the registry Blade source.
total	int	512	Declared by @props in the registry Blade source.
label	string	Usage	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

usage-meter

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.usage-meter.default.blade.php Blade

<div class="mx-auto flex w-full max-w-sm flex-col gap-4">
    <x-ui.usage-meter :used="3200" :total="8000" label="Storage" />
    <x-ui.usage-meter :used="7600" :total="8000" label="Storage" />
</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: v2.0.0. See the site changelog for the full release history.

Meters