Navigation & disclosureExplore · Adapt · Compose
Collapsible
Progressive disclosure with open/onOpenChange, asChild triggers, height animation (accordion-style), shadcn-aligned examples. Organize content into understandable destinations and reveal detail when it becomes relevant. Keep the active location or expanded state easy to recognize. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.
The examples use @/components/kamod-ui/collapsible in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.
In this guide 7 sections
Installation
Import Collapsible, CollapsibleTrigger and CollapsibleContent from @/components/kamod-ui/collapsible. Motion is optional — core CollapsibleContent includes CSS height animation.
pnpm add @kamod-ch/uiThe @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.
Usage
Wrap trigger and content. Use open and onOpenChange for controlled state. Use CollapsibleTrigger asChild with Button for icon toggles. CollapsibleContent animates height (respects prefers-reduced-motion).
import { Collapsible } from "@/components/kamod-ui/collapsible";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component examples & variants
Explore Collapsible in different contexts, from the starting pattern to the compositions below. Begin with Demo, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.
Read the result and its implementation together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the component styles guide for hierarchy and the theming guide for shared surfaces and colors. The accessibility notes explain what to preserve when making those changes.
Demo
Controlled order card with ghost icon trigger (shadcn CollapsibleDemo).
// See previewCode hero — open + onOpenChange, asChild Button, ChevronsUpDown.Usage
Minimal default button trigger and unstyled content.
Controlled state
Use open and onOpenChange to control visibility from outside.
Basic
Card with full-width ghost trigger and rotating chevron (shadcn Basic).
Settings panel
Extra fields in a subgrid with maximize/minimize trigger (shadcn Settings).
File tree
Nested collapsibles with folder chevrons and Tabs header (shadcn File Tree).
Props and data
Configure Collapsible using the contracts below. Read the documented options alongside the source definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.
Props, slots and variants for this component.
TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.TypeScriptComponent props
? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.Collapsible
Collapsible component props and accepted values.
| Prop / type | Description |
|---|---|
defaultOpen | Uncontrolled initial state Documented default |
open | Controlled open state Documented default |
onOpenChange | Called when open state changes (toggle or programmatic) Documented default |
CollapsibleTrigger asChild | Documented CollapsibleTrigger asChild option for Collapsible. Check its type alongside the usage examples before supplying a value. Documented default |
CollapsibleContent forceMount | Documented CollapsibleContent forceMount option for Collapsible. Check its type alongside the usage examples before supplying a value. Documented default |
CollapsibleContent duration / timingFunction | Documented CollapsibleContent duration / timingFunction option for Collapsible. Check its type alongside the usage examples before supplying a value. Documented default |
Data type reference
Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the implementation source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.
CollapsibleContextValueopen, setOpenCollapsiblePropsCollapsibleContentPropsCollapsibleTriggerPropsAccessibility
Build the complete interaction, including the parts outside Collapsible. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.
Built-in behavior and defaults
CollapsibleTrigger communicates aria-expanded, while closed content uses hidden/inert handling. It is a disclosure pattern, not a dialog: opening content does not imply a modal focus trap or a new window.
Labels and relationships
Give the trigger a persistent subject, such as Advanced filters, so its expanded state can explain visibility. Name icon-only triggers explicitly. If adding aria-controls, point it to the actual content ID and keep that ID unique.
Keyboard and focus
A native trigger button supports Enter and Space. After opening, subsequent Tab navigation should reach the revealed controls in document order. If closing while focus is inside, move focus to a useful surviving element rather than hiding it.
States and integration details
Do not use CSS opacity alone to hide interactive content. Keep hidden-state behavior intact when customizing animation, and avoid putting the only route to required fields behind an unlabeled chevron.
Verify the complete interaction
Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.
- Toggle from the keyboard and verify the announced expanded state matches visible content.
- Check focus during close transitions, including reduced-motion settings.
- Render a second disclosure and verify state and any custom content IDs remain independent.
Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.
For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.
Build it into your interface
Use the Collapsible examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.
Connect the behavior
Use stable identifiers when items come from data, especially when they can be reordered. Keep links as real destinations and use disclosure controls for revealing content. Decide whether selection belongs to local state, the URL or a parent component before connecting callbacks.
Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.
Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.
Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.
Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.
Refine the presentation
Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Collapsible.
import type { ComponentChildren } from "preact";
export function ExampleSurface({ children }: { children: ComponentChildren }) {
return (
<div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
{children}
</div>
);
}Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.
Review the complete interaction
- Try long labels, nested content and an empty list without changing the focus order.
- Verify the documented arrow-key and activation behavior where the pattern supports it.
- Check the selected or expanded item after data changes and while navigating back to the page.
The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.
Compose a complete interface
Collapsible is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.
Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.
Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.
Sources & design references
Follow Collapsible from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.
Bring it back to your app
A reference becomes useful when it fits your real content. Work through these decisions in order:
- Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
- Make the styling repeatable. Use the styles guide for local
classadjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode. - Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.