mirror of
https://github.com/hanzoai/shadcn.git
synced 2026-10-30 18:22:59 +00:00
zeekay
16c4453cc1
Squash merge of shadcn-ui/ui main branch into hanzo/ui, bringing in: - [email protected] through [email protected] releases - New apps/v4 directory structure - Registry system improvements and MCP server - Framework support (Vue, Svelte, React Native) - New templates (vite-app, monorepo-next, laravel) - Zod 4 compatibility (scoped override for zod@>4) - Test fixture corrections for alias resolution All 867 merge conflicts resolved preserving Hanzo customizations. 1020/1020 shadcn tests pass.
135 lines
2.6 KiB
Plaintext
135 lines
2.6 KiB
Plaintext
---
|
|
title: Collapsible
|
|
description: An interactive component which expands/collapses a panel.
|
|
base: base
|
|
component: true
|
|
featured: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/collapsible
|
|
api: https://base-ui.com/react/components/collapsible#api-reference
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="collapsible-demo" align="start" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add collapsible
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @base-ui/react
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="collapsible"
|
|
title="components/ui/collapsible.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Collapsible,
|
|
CollapsibleContent,
|
|
CollapsibleTrigger,
|
|
} from "@/components/ui/collapsible"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<Collapsible>
|
|
<CollapsibleTrigger>Can I use this in my project?</CollapsibleTrigger>
|
|
<CollapsibleContent>
|
|
Yes. Free to use for personal and commercial projects. No attribution
|
|
required.
|
|
</CollapsibleContent>
|
|
</Collapsible>
|
|
```
|
|
|
|
## Controlled State
|
|
|
|
Use the `open` and `onOpenChange` props to control the state.
|
|
|
|
```tsx showLineNumbers
|
|
import * as React from "react"
|
|
|
|
export function Example() {
|
|
const [open, setOpen] = React.useState(false)
|
|
|
|
return (
|
|
<Collapsible open={open} onOpenChange={setOpen}>
|
|
<CollapsibleTrigger>Toggle</CollapsibleTrigger>
|
|
<CollapsibleContent>Content</CollapsibleContent>
|
|
</Collapsible>
|
|
)
|
|
}
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Basic
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="collapsible-basic"
|
|
align="start"
|
|
/>
|
|
|
|
### Settings Panel
|
|
|
|
Use a trigger button to reveal additional settings.
|
|
|
|
<ComponentPreview styleName="base-nova" name="collapsible-settings" />
|
|
|
|
### File Tree
|
|
|
|
Use nested collapsibles to build a file tree.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="collapsible-file-tree"
|
|
previewClassName="h-[36rem]"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="collapsible-rtl"
|
|
direction="rtl"
|
|
align="start"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/collapsible#api-reference) documentation for more information.
|