Prop | Default | Type |
---|---|---|
as | 'div' | AsTag | Component The element or component this component should render as. Can be overwritten by |
asChild | boolean Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
collapsedSize | number The size of panel when it is collapsed. | |
collapsible | boolean Should panel collapse when resized beyond its | |
defaultSize | number Initial size of panel (numeric value between 1-100) | |
id | string Panel id (unique within group); falls back to | |
maxSize | number The maximum allowable size of panel (numeric value between 1-100); defaults to | |
minSize | number The minimum allowable size of panel (numeric value between 1-100); defaults to | |
order | number The order of panel within group; required for groups with conditionally rendered panels |
Emit | Payload |
---|---|
collapse | [] Event handler called when panel is collapsed. |
expand | [] Event handler called when panel is expanded. |
resize | [size: number, prevSize: number] Event handler called when panel is resized; size parameter is a numeric value between 1-100. |
Slots (default) | Payload |
---|---|
isCollapsed | boolean Is the panel collapsed |
isExpanded | boolean Is the panel expanded |
collapse | (): void If panel is |
expand | (): void If panel is currently collapsed, expand it to its most recent size. |
resize | (size: number): void Resize panel to the specified percentage (1 - 100). |
Methods | Type |
---|---|
collapse | () => void If panel is |
expand | () => void If panel is currently collapsed, expand it to its most recent size. |
getSize | () => number Gets the current size of the panel as a percentage (1 - 100). |
resize | (size: number) => void Resize panel to the specified percentage (1 - 100). |