Collapsible

Repositories

@ag/ui

Installation#

pnpm add @ag/ui

Usage#

import {
  Collapsible,
  CollapsibleContent,
  CollapsibleTrigger,
} from "@ag/ui"

<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>

Composition#

Use the following composition to build a Collapsible:

Collapsible
├── CollapsibleTrigger
└── CollapsibleContent

Controlled State#

Use the open and onOpenChange props to control the state.

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#

Settings Panel#

Use a trigger button to reveal additional settings.

File Tree#

Use nested collapsibles to build a file tree.

RTL#

To enable RTL support in shadcn/ui, see the RTL configuration guide.

API Reference#

See the Radix UI documentation for more information.