Preview

1

2

3

4

5

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 carousel

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './carousel.js';

Registry contract

Install confidence

php artisan ui:add carousel 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.1.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/carousel.blade.php
blade	resources/views/components/ui/carousel/content.blade.php
blade	resources/views/components/ui/carousel/item.blade.php
blade	resources/views/components/ui/carousel/previous.blade.php
blade	resources/views/components/ui/carousel/next.blade.php
js	resources/js/ui/carousel.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 carousel 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
loop	bool	false	Wrap previous/next navigation at the first and last slide.
orientation	string	horizontal	Declared by @props in the registry Blade source.
autoplay	bool	false	Declared by @props in the registry Blade source.
interval	int	4000	Declared by @props in the registry Blade source.

Slots

default — Compose carousel.content, carousel.item, carousel.previous, and carousel.next.
x-ui.carousel.content — Installed subcomponent from the registry item.
x-ui.carousel.item — Installed subcomponent from the registry item.
x-ui.carousel.previous — Installed subcomponent from the registry item.
x-ui.carousel.next — Installed subcomponent from the registry item.

Data slots

carousel carousel-content carousel-item carousel-next carousel-previous carousel-track

Capabilities

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

Behavior

Uses server-rendered Blade and semantic HTML.
Uses region semantics, keyboard navigation, button controls, and aria-disabled state for boundaries when loop is off.
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.carousel.default.blade.php Blade

<x-ui.carousel class="mx-auto w-full max-w-sm px-12">
    <x-ui.carousel.content>
        @foreach (range(1, 5) as $slide)
            <x-ui.carousel.item>
                <div class="flex aspect-square items-center justify-center rounded-md border border-border bg-card p-6 text-3xl font-semibold text-card-foreground">
                    {{ $slide }}
                </div>
            </x-ui.carousel.item>
        @endforeach
    </x-ui.carousel.content>
    <x-ui.carousel.previous />
    <x-ui.carousel.next />
</x-ui.carousel>

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.1.0. See the site changelog for the full release history.

Carousels