Skip to Content
DocsCloud UI BusinessCollapsibleCard

CollapsibleCard

A card component with collapsible/expandable content section, featuring a clickable header with chevron animation.

Import

import { CollapsibleCard } from '@tidbcloud/uikit/biz'

Basic Usage

import { CollapsibleCard } from '@tidbcloud/uikit/biz' function Demo() { return ( <CollapsibleCard header="Click to expand"> <p>This content can be collapsed or expanded.</p> </CollapsibleCard> ) }

Default Open

import { CollapsibleCard } from '@tidbcloud/uikit/biz' function Demo() { return ( <CollapsibleCard header="Expanded by default" defaultOpened> <p>This content is visible by default.</p> </CollapsibleCard> ) }

Controlled

import { useState } from 'react' import { CollapsibleCard } from '@tidbcloud/uikit/biz' function Demo() { const [opened, setOpened] = useState(false) return ( <CollapsibleCard header="Controlled card" opened={opened} onToggle={() => setOpened(!opened)}> <p>Controlled collapsible content.</p> </CollapsibleCard> ) }

Custom Header

import { CollapsibleCard } from '@tidbcloud/uikit/biz' import { Group, Badge, Text } from '@tidbcloud/uikit' function Demo() { return ( <CollapsibleCard header={ <Group> <Text fw={600}>Advanced Settings</Text> <Badge>3 options</Badge> </Group> } > <p>Settings content here.</p> </CollapsibleCard> ) }

Props

PropTypeDefaultDescription
headerReactNode-Card header/title content
childrenReactNode-Collapsible content
openedboolean-Controlled open state
defaultOpenedbooleanfalseInitial open state
headerPropsBoxProps-Props for header section
contentPropsCollapseProps-Props for content section
onToggle(opened: boolean) => void-Callback when toggled
onTransitionEnd() => void-Callback after transition
Last updated on