Accordion

Accordion

new Accordion(element, options)

Source:
Parameters:
NameTypeDescription
elementHTMLElement

DOM element for component instantiation and scope

optionsObject
Properties
NameTypeDescription
toggleSelectorString

Selector for toggling element

iconSelectorString

Selector for icon element

attachClickListenerBoolean

Whether or not to bind click events on toggle

Classes

Accordion

Methods

destroy()

Description:
  • Destroy component.

Source:

handleClickOnToggle(toggle)

Source:
Parameters:
NameTypeDescription
toggleHTMLElement

Target element to toggle.

Fires:

handleClickOutside(Event)

Source:
Parameters:
NameTypeDescription
Evente

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 'click' event
accordion.on('onToggle', (event) => {
  console.log('Toggle event occurred!', event);
});
Parameters:
NameTypeDescription
eventNamestring

The name of the event to listen for.

callbackfunction

The callback function to be invoked when the event occurs.

Returns:
Type
void

trigger(eventName, eventData)

Description:
  • Trigger a component event.

Source:
Parameters:
NameTypeDescription
eventNamestring

The name of the event to trigger.

eventDataany

Data associated with the event.

(static) autoInit(root) → {Accordion}

Source:
Parameters:
NameTypeDescription
rootHTMLElement

DOM element for component instantiation and scope

Returns:

An instance of Accordion.

Type
Accordion

Events

onToggle

Description:
  • An array of supported events for this component.

Source:
Type:
  • Array.<string>