Leave Yamada UI a star

Star
Yamada UIYamada UIv1.5.1

Collapse

Collapse is a component that allows you to expand or collapse an element for display.

Source@yamada-ui/transitions

Props

CollapseProps

animationOpacity

Description

If true, the opacity of the content will be animated.

Type

boolean

Default

true

as

Type

"symbol" | "object" | "clipPath" | "filter" | "mask" | "marker" | "text" | "g" | "p" | "big" | "link" | "small" | "sub" | "sup" | "style" | "animate" | "div" | "a" | "abbr" | "address" | ... 148 more ... | "textPath"

colorScheme

Description

The visual color appearance of the component.

Type

"whiteAlpha" | "blackAlpha" | "gray" | "neutral" | "red" | "danger" | "rose" | "pink" | "flashy" | "orange" | "warning" | "amber" | "yellow" | "lime" | "green" | "success" | "emerald" | "teal" | "cyan" | "sky" | "blue" | "primary" | "info" | "link" | "indigo" | "violet" | "secondary" | "purple" | "fuchsia"

delay

Description

Custom delay definition for enter and exit.

Type

number | Partial<Record<"exit" | "enter", number>>

duration

Description

Custom duration definition for enter and exit.

Type

number | Partial<Record<"exit" | "enter", number>>

endingHeight

Description

The height you want the content in its expanded state.

Type

string | number

Default

auto

enter

Description

Custom enter.

Type

any

isOpen

Description

Show the component. triggers when enter or exit states.

Type

boolean

size

Description

The size of the Collapse.

Type

string

startingHeight

Description

The height you want the content in its collapsed state.

Type

string | number

Default

0

transition

Description

Custom transition definition for enter and exit.

Type

Partial<Record<"exit" | "enter", Transition$1>>

transitionEnd

Description

Custom transitionEnd definition for enter and exit.

Type

Partial<Record<"exit" | "enter", MakeCustomValueType<TargetProperties>>>

unmountOnExit

Description

If true, the element will unmount when isOpen={false} and animation is done.

Type

boolean

variant

Description

The variant of the Collapse.

Type

string

Edit this page on GitHub

PreviousTransitionsNextFade