HowTo-Komponenten – HowTo-Kurzinfo

Zusammenfassung

Ein <howto-tooltip> ist ein Pop-up, das Informationen zu einem Element anzeigt, wenn das Element Tastaturfokus auf das Element legt oder der Mauszeiger darüber bewegt wird. Das Element, das die Kurzinfo auslöst, verweist mit aria-describedby auf das Element der Kurzinfo.

Das Element wendet die Rolle tooltip selbst an und legt tabindex auf -1 fest, da die Kurzinfo nie hervorgehoben werden kann.

Referenz

Demo

Live-Demo auf GitHub ansehen

Anwendungsbeispiel

<div class="text">
<label for="name">Your name:</label>
<input id="name" aria-describedby="tp1"/>
<howto-tooltip id="tp1">Ideally your name is Batman</howto-tooltip>
<br>
<label for="cheese">Favourite type of cheese: </label>
<input id="cheese" aria-describedby="tp2"/>
<howto-tooltip id="tp2">Help I am trapped inside a tooltip message</howto-tooltip>

Code

class HowtoTooltip extends HTMLElement {

Der Konstruktor funktioniert und muss genau einmal ausgeführt werden.

  constructor() {
    super();

Diese Funktionen werden an verschiedenen Stellen verwendet und müssen immer den richtigen Verweis binden. Führen Sie dies also einmal durch.

    this._show = this._show.bind(this);
    this._hide = this._hide.bind(this);
}

connectedCallback() wird ausgelöst, wenn das Element in das DOM eingefügt wird. Hier können Sie die anfängliche Rolle, den Tabindex und den internen Status festlegen und Ereignis-Listener installieren.

  connectedCallback() {
    if (!this.hasAttribute('role'))
      this.setAttribute('role', 'tooltip');

    if (!this.hasAttribute('tabindex'))
      this.setAttribute('tabindex', -1);

    this._hide();

Das Element, das die Kurzinfo auslöst, verweist auf das Element der Kurzinfo mit aria-describedby.

    this._target = document.querySelector('[aria-describedby=' + this.id + ']');
    if (!this._target)
      return;

Die Kurzinfo muss auf Fokus-/Unkenntlichmachungsereignisse des Ziels sowie auf Ereignisse, wenn der Mauszeiger auf das Ziel bewegt wird, warten.

    this._target.addEventListener('focus', this._show);
    this._target.addEventListener('blur', this._hide);
    this._target.addEventListener('mouseenter', this._show);
    this._target.addEventListener('mouseleave', this._hide);
  }

disconnectedCallback() hebt die Registrierung der Event-Listener auf, die in connectedCallback() eingerichtet wurden.

  disconnectedCallback() {
    if (!this._target)
      return;

Entfernen Sie die vorhandenen Listener, damit sie nicht ausgelöst werden, auch wenn keine Kurzinfo vorhanden ist.

    this._target.removeEventListener('focus', this._show);
    this._target.removeEventListener('blur', this._hide);
    this._target.removeEventListener('mouseenter', this._show);
    this._target.removeEventListener('mouseleave', this._hide);
    this._target = null;
  }

  _show() {
    this.hidden = false;
  }

  _hide() {
    this.hidden = true;
  }
}

customElements.define('howto-tooltip', HowtoTooltip);