Skip to content
UI Brok

Loading…

No results

Browse catalog

Meters

Single-value readouts of a fraction of a whole — an arc gauge, a circular progress ring, and linear/radial usage readouts.

Circular Progress

Preview

25%
72%
100%
Loading…

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 circular-progress

Registry contract

Install confidence

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

Registry dependencies

None.

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 circular-progress 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

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
value int 0 Declared by @props in the registry Blade source.
max int 100 Declared by @props in the registry Blade source.
size int 44 Declared by @props in the registry Blade source.
stroke int 4 Declared by @props in the registry Blade source.
showValue bool true Declared by @props in the registry Blade source.
indeterminate bool false Declared by @props in the registry Blade source.
label mixed|null null 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

circular-progress circular-progress-value

Capabilities

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

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized, reducedMotion.

Usage

previews.components.circular-progress.default.blade.php Blade
<div class="flex flex-wrap items-center justify-center gap-8">
    <div class="flex flex-col items-center gap-2">
        <x-ui.circular-progress :value="25" :size="64" :stroke="6" />
        <span class="text-sm text-muted-foreground">25%</span>
    </div>
    <div class="flex flex-col items-center gap-2">
        <x-ui.circular-progress :value="72" :size="64" :stroke="6" />
        <span class="text-sm text-muted-foreground">72%</span>
    </div>
    <div class="flex flex-col items-center gap-2">
        <x-ui.circular-progress :value="100" :size="64" :stroke="6" />
        <span class="text-sm text-muted-foreground">100%</span>
    </div>
    <div class="flex flex-col items-center gap-2">
        <x-ui.circular-progress indeterminate :size="64" :stroke="6" :show-value="false" />
        <span class="text-sm text-muted-foreground">Loading…</span>
    </div>
</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.0. See the site changelog for the full release history.