ESL Toggleable

ESLToggleable - a custom element, that is used as a base for "Popup-like" components creation.

ESLToggleableDispatcher - plugin component, that prevents activation of multiple ESLToggleable instances in bounds of managed container. Usually (and by default) binds to document.body. Uses native DOM events to manage controlled instances state.

Use ESLToggleableDispatcher.init() to initialize (and bind) ESLToggleableDispatcher.

Toggleable Attributes / Properties

  • open - active state marker

  • active-class - CSS class(es) (supports CSSClassUtils syntax) to add when the Toggleable is active (and remove when inactive)

  • body-class - CSS class(es) (supports CSSClassUtils syntax) to add on the body element (removes when inactive).

  • container-active-class - CSS class(es) (supports CSSClassUtils syntax) to add when the Toggleable is active (and remove when inactive) to/from 'container' element defined by container-active-class-target.

  • container-active-class-target - selector for the closest parent element to add/remove classes from container-active-class. The default value is * (direct parent).

  • group (groupName) - Toggleable group meta information to organize groups

  • no-auto-id - Disallow automatic id creation when it's empty

  • close-on (closeTrigger) - Selector to mark inner close triggers

  • close-on-esc - Close the Toggleable on ESC keyboard event

  • close-on-outside-action - Close the Toggleable on a click/tap outside

  • initial-params - Initial params to pass to show/hide action on start

  • default-params - Default params to merge into passed action params

Toggleable Implementation API

  • onShow - 'show' actions to execute when the instance becomes active
  • onHide - 'hide' actions to execute when the instance becomes inactive

Toggleable Public API:

  • show - trigger element activation
  • hide - trigger element deactivation
  • toggle - toggle element state

Events

  • esl:before:show - thrown when toggleable change is going to be activated(open)
  • esl:before:hide - thrown when toggleable change is going to be deactivated
  • esl:show - thrown when toggleable change its state to active(open)
  • esl:hide - thrown when toggleable change its state to inactive

ESL Related Target

ESLRelatedTarget is a custom mixin that can be used in combination with ESLToggleable instance (or any inheritor) to link it with one or more other ESLToggleable to sync their states.

Mixin attaches to the element via the esl-related-target attribute. The attribute's value defines a selector to find the corresponding element. Activation (set open state) or deactivation of the related target happens when the corresponding esl:show or esl:hide DOM events are dispatched on the current host element.

Mixin supports esl-related-target-action attribute to define required for synchronization actions:

  • all (default) - to synchronize both: show and hide events of the observed toggleable
  • hide - to synchronize only hide events of the observed toggleable
  • show - to synchronize only show events of the observed toggleable

To make cross-reference (bidirectional binding) of toggleables you need to cross-reference both of the toggleables:

<esl-toggleable class="first" esl-related-target=".second"></esl-toggleable>
<esl-toggleable class="second" esl-related-target=".first"></esl-toggleable>