Interface representing the API for a collapsible component.
close():
void
Triggers collapse closing programmatically.
void
open():
void
Triggers the collapse content to be displayed for the user.
void
toggle():
void
Toggles the collapse content visibility.
void
Interface representing the directives used in a collapse component.
collapseDirective:
Directive
Directive to apply the collapse.
triggerDirective:
Directive
Directive to apply to a trigger;
Properties for the Collapse component.
animated:
boolean
If true, collapse closing and opening will be animated.
true
animatedOnInit:
boolean
If true, collapse opening will be animated at init time.
false
id:
string
id of the collapse
''
onHidden: () =>
void
Callback called when the collapse is hidden.
void
() => {}onShown: () =>
void
Callback called when the collapse is shown.
void
() => {}onVisibleChange: (
visible) =>void
Callback called when the collapse visibility changed.
boolean
The new visibility state of the collapse.
void
() => {}transition:
TransitionFn
The transition function will be executed when the collapse is displayed or hidden.
Depending on the value of animatedOnInit, the animation can be optionally skipped during the showing process.
() => {}
visible:
boolean
If true the collapse is visible to the user
true
Represents the state of a Collapse component.
hidden:
boolean
Is true when the collapse is hidden. Compared to visible, this is updated after the transition is executed.
visible:
boolean
If true the collapse is visible to the user
true
CollapseWidget =
Widget<CollapseProps,CollapseState,CollapseApi,CollapseDirectives>
Represents a widget for handling collapse functionality.
This type defines the structure of a CollapseWidget, which includes properties, state, API, and directives necessary for managing the collapse behavior in the UI.
constcreateCollapse:WidgetFactory<CollapseWidget>
Create an CollapseWidget factory
the transition function that will be used for the collapse
an CollapseWidget
getCollapseDefaultConfig():
CollapseProps
Retrieve a shallow copy of the default collapse config
the default collapse config