useCollapsible
@astryxdesign/core v0.7.1 · useCollapsible
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
isCollapsible | boolean | CollapsibleConfig | MaybeRefOrGetter | true | Whether collapsible behavior is active. true manages its own state and starts open. false disables folding. Pass a config object for controlled mode or a custom default. |
value | string | undefined | MaybeRefOrGetter | — | Unique identifier within a CollapsibleGroup. When present and inside a group, the group owns the state. |
group | CollapsibleGroupContextValue | null | injected | Group context. Read from the nearest CollapsibleGroup when omitted; pass it explicitly only when you are outside that tree. |
CollapsibleConfig
| Field | Type | Default | Description |
|---|---|---|---|
isOpen | Ref<boolean | undefined> | — | Controlled open state, usually the v-model:isOpen model ref. Leave it out for uncontrolled state. |
defaultIsOpen | boolean | MaybeRefOrGetter | true | Open state while isOpen stays unbound. |
onOpenChange | (isOpen: boolean) => void | — | Called with the requested state. In controlled usage it is the request; in uncontrolled usage it is the report. |
Returns
| Field | Type | Description |
|---|---|---|
isEnabled | ComputedRef<boolean> | Whether collapsible behavior is active. False when isCollapsible is false. |
isOpen | ComputedRef<boolean> | Whether the content is currently expanded. |
toggle | () => void | Toggle open/closed state. Dispatches to the group, the controlled ref, or internal state. |