new Expandable(element, options)
- Source:
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
element | HTMLElement | DOM element for component instantiation and scope | ||||||||||||||||||
options | Object | Properties
|
Classes
Methods
destroy()
- Description:
Destroy component.
- Source:
handleClickOnToggle()
- Description:
Toggles between collapsed/expanded states.
- Source:
Fires:
- Expandable#event:handleToggle
init()
- Description:
Initialise component.
- Source:
on(eventName, callback) → {void}
- Description:
Register a callback function for a specific event.
- Source:
Example
// Registering a callback for the 'onToggle' event
expandable.on('onToggle', (event) => {
console.log('Toggle event occurred!', event);
});
Parameters:
Name | Type | Description |
---|---|---|
eventName | string | The name of the event to listen for. |
callback | function | The callback function to be invoked when the event occurs. |
Returns:
- Type
- void
trigger(eventName, eventData)
- Description:
Trigger a component event.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
eventName | string | The name of the event to trigger. |
eventData | any | Data associated with the event. |
(static) autoInit(root) → {Expandable}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
root | HTMLElement | DOM element for component instantiation and scope |
Returns:
An instance of Expandable.
- Type
- Expandable
Events
onToggle
- Description:
An array of supported events for this component.
- Source:
Type:
- Array.<string>