Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 1.98 KB

README.md

File metadata and controls

65 lines (48 loc) · 1.98 KB
Raw

ESL Alert

Version: 2.0.0.

Authors: Julia Murashko, Alexey Stsefanovich (ala'n).

ESLAlert is a component to show small notifications on your pages.

The ESLAlert instances are controlled via DOM events dispatched on the observed target. ESLAlert can have multiple instances on the page.

Usage

First, use the common approach to register component: ESLAlert.register(). Then you can attach <esl-alert> component to the expected place in the document or initialize it globally by using ESLAlert.init shortcut.

ESL Alert listens to DOM events to control its state. By default, the target to catch alerts is the esl-alert parent element. Target can be changed using target attribute with the ESLTraversingQuery support, or through the $target property that accepts any EventTarget instance (including the window).

ESL Alert listens to the following events:

  • esl:alert:show to show alert
  • esl:alert:hide to hide alert

Use CustomEvent details to customize alert. Alert details accepts the following properties:

  • cls - to pass class or classes(separated by space) to add to alert inner
  • text - to specify alert text content
  • html - to alternatively specify alert HTML content
  • hideDelay - to specify the time in milliseconds after which the alert will be hidden automatically
  • hideTime - to specify internal hide timeout in milliseconds to clear inner content. Starts when alert becomes visually hidden (e.g. after hideDelay passed)

If one of esl-alerts catches the activation event it will prevent its propagation to parent elements.

Example

<body>
  <div class="container">
    ...
    <my-component></my-component>
    ...
  </div>
  <esl-alert></esl-alert>
</body>
// my-component
this.dispatchEvent(new CustomEvent(`esl:alert:show`, {
  detail: {
    text: 'Hello World',
    cls: 'alert alert-info'
  }
}));