Preview

Installation

terminal

php artisan ui:add scroll-area

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './scroll-area.js';

Registry contract

Install confidence

php artisan ui:add scroll-area 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-area.blade.php
blade	resources/views/components/ui/scroll-area/viewport.blade.php
blade	resources/views/components/ui/scroll-area/scrollbar.blade.php
blade	resources/views/components/ui/scroll-area/thumb.blade.php
js	resources/js/ui/scroll-area.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Layout and content structure

Structure content hierarchy and responsive relationships.

Use when

Use to structure hierarchy, spacing, and responsiveness so content is easier to scan and navigate. Do not let layout primitives substitute for semantics, headings, or interaction rules users still need.

Avoid when

Avoid using scroll-area 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: low
Interruptiveness: none
Input precision: none
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Semantic HTML with standard flow

Anti-patterns

Using visual layout as a substitute for semantic structure

API

manifest knowledge + registry-derived coverage

Props

No documented props. Pass normal Blade attributes through the component root.

Slots

default — Primary Blade slot rendered by the component.
x-ui.scroll-area.viewport — Installed subcomponent from the registry item.
x-ui.scroll-area.scrollbar — Installed subcomponent from the registry item.
x-ui.scroll-area.thumb — Installed subcomponent from the registry item.

Data slots

scroll-area scroll-area-scrollbar scroll-area-thumb scroll-area-viewport

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

<x-ui.scroll-area class="h-48 w-64 rounded-md border border-border">
    <x-ui.scroll-area.viewport class="p-4">
        <h4 class="mb-4 text-sm font-medium leading-none">{{ __('Tags') }}</h4>
        <div class="text-sm">{{ __('tags v1.0.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.1.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.2.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.3.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.4.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.5.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.6.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.7.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.8.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v1.9.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v2.0.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v2.1.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v2.2.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v2.3.0') }}</div>
        <div class="mt-3 text-sm">{{ __('tags v2.4.0') }}</div>
    </x-ui.scroll-area.viewport>
    <x-ui.scroll-area.scrollbar>
        <x-ui.scroll-area.thumb />
    </x-ui.scroll-area.scrollbar>
</x-ui.scroll-area>

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 Area