mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-01 16:44:24 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
124 lines
2.4 KiB
Plaintext
124 lines
2.4 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]"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/collapsible#api-reference) documentation for more information.
|