Skip to content

useCollapsible

@astryxdesign/core v0.7.1 · useCollapsible

参数 ​

参数类型默认值说明
isCollapsibleboolean | CollapsibleConfig | MaybeRefOrGettertrue是否启用折叠。传 true 自己管状态且初始展开;传 false 关闭折叠;传配置对象表示受控,或自定义默认值。
valuestring | undefined | MaybeRefOrGetter—在 CollapsibleGroup 里的唯一标识。有值且在组内时,状态由组管理。
groupCollapsibleGroupContextValue | null自动注入组上下文。不传就从最近的 CollapsibleGroup 读取;只有不在那棵树里时才需要手动传。

CollapsibleConfig ​

字段类型默认值说明
isOpenRef<boolean | undefined>—受控的展开状态,通常就是 v-model:isOpen 的 model ref。留空表示不受控。
defaultIsOpenboolean | MaybeRefOrGettertrueisOpen 没绑定时,内容初始是否展开。
onOpenChange(isOpen: boolean) => void—状态要变化时调用,参数是目标状态。受控时它是请求,不受控时它是通知。

返回值 ​

字段类型说明
isEnabledComputedRef<boolean>折叠能力是否生效。isCollapsible 为 false 时是 false。
isOpenComputedRef<boolean>内容当前是否展开。
toggle() => void切换展开状态:组内交给组,否则写受控 ref 或内部状态。