Preview

This content is hidden until you expand the section.

It collapses again when you toggle the trigger.

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 collapsible

Behavior layer (Alpine)

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

resources/js/ui/index.js JS

import './collapsible.js';

Registry contract

Install confidence

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

Type	Generated target
blade	resources/views/components/ui/collapsible.blade.php
blade	resources/views/components/ui/collapsible/trigger.blade.php
blade	resources/views/components/ui/collapsible/content.blade.php
js	resources/js/ui/collapsible.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Progressive disclosure

Reveal optional or secondary content on demand.

Use when

Use for secondary or optional content, especially when users usually inspect one short section at a time. Do not hide required workflow content or comparison-heavy information because disclosure controls reduce visibility and increase interaction cost.

Avoid when

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

Preferred alternatives

Visible sections
Tabs for a few long peer sections

Anti-patterns

Hiding required workflow content
Using accordions for cross-section comparison

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
open	bool	false	Declared by @props in the registry Blade source.
indicator	string	none	Declared by @props in the registry Blade source.
indicatorSide	string	end	Declared by @props in the registry Blade source.

Slots

default — Primary Blade slot rendered by the component.
x-ui.collapsible.trigger — Installed subcomponent from the registry item.
x-ui.collapsible.content — Installed subcomponent from the registry item.

Data slots

collapsible collapsible-content collapsible-trigger

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

<x-ui.collapsible class="w-full max-w-md">
    <x-ui.collapsible.trigger class="w-full px-4 py-2 text-foreground hover:bg-muted">{{ __('Show details') }}</x-ui.collapsible.trigger>
    <x-ui.collapsible.content class="px-4 py-2 text-muted-foreground">
        <p>{{ __('This content is hidden until you expand the section.') }}</p>
        <p>{{ __('It collapses again when you toggle the trigger.') }}</p>
    </x-ui.collapsible.content>
</x-ui.collapsible>

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

Collapsible