Skip to content
UI Brok

Loading…

No results

Browse catalog

Velocity Scroll

A full-width band of seamlessly scrolling text that accelerates with scroll velocity and flips direction with scroll direction.

Preview

Scroll to accelerate ·

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

Behavior layer (Alpine)

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

resources/js/ui/index.js JS 
import './velocity-scroll.js';

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Expressive and showcase effect

Support brand expression or a showcase moment.

Use when

  • Use only when visual expression supports storytelling, brand differentiation, or a clear showcase moment. Do not place heavy effects in task-dense workflows where clarity, speed, and readability matter more.

Avoid when

  • Avoid using velocity-scroll 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
short
Interaction cost
medium
Interruptiveness
low
Input precision
none
Mobile / touch risk
high
Accessibility risk
high
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Static content-first presentation

Anti-patterns

  • Heavy effects in forms or task-dense workflows
  • Motion that interferes with reading or focus

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
text string Declared by @props in the registry Blade source.
baseVelocity int 4 Declared by @props in the registry Blade source.
direction string left Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

velocity-scroll velocity-scroll-copy velocity-scroll-track

Capabilities

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

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, reducedMotion.

Usage

previews.components.velocity-scroll.default.blade.php Blade 
<x-ui.velocity-scroll text="Scroll to accelerate · " class="text-4xl font-bold text-foreground" />

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.