Preview

Scroll the panel below to fill the ring and bar.

Paragraph 1 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 2 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 3 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 4 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 5 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 6 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 7 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 8 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 9 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 10 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 11 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

Paragraph 12 — Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.

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

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './scroll-progress.js';

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Progress and sequence

Communicate genuine progress or ordered stages.

Use when

Use to show real progress, ordered stages, or process status when visibility helps completion. Do not add progress UI to tiny tasks or to flows whose steps are not meaningfully sequential.

Avoid when

Avoid using scroll-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: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Simple completion text for tiny tasks

Anti-patterns

Decorative or inaccurate progress
Steppers for nonsequential exploration

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
variant	string	linear	Declared by @props in the registry Blade source.
target	mixed\|null	null	Declared by @props in the registry Blade source.
position	string	top	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

scroll-progress scroll-progress-indicator scroll-progress-ring

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.scroll-progress.default.blade.php Blade

<div class="flex w-full max-w-md flex-col gap-6">
    {{-- Circular ring tracking the scroll container below. --}}
    <div class="flex items-center gap-3">
        <x-ui.scroll-progress variant="circular" target="#scroll-progress-demo" />
        <span class="text-muted-foreground text-sm">{{ __('Scroll the panel below to fill the ring and bar.') }}</span>
    </div>

    {{-- Static linear bar tied to the same scrollable container. --}}
    <x-ui.scroll-progress variant="linear" position="static" target="#scroll-progress-demo" />

    {{-- The scroll source. Tall content forces overflow. --}}
    <div id="scroll-progress-demo" class="h-40 overflow-auto rounded-md border border-border p-4" tabindex="0" role="region" aria-label="Scrollable content">
        <div class="space-y-4">
            @foreach (range(1, 12) as $i)
                <p class="text-muted-foreground text-sm">
                    {{ __('Paragraph') }} {{ $i }} — {{ __('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Keep scrolling to watch the progress indicators advance toward 100%.') }}
                </p>
            @endforeach
        </div>
    </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.

Scroll Progress