Composants HowTo – Howto-tooltip

Un <howto-tooltip> est une fenêtre pop-up qui affiche des informations sur un élément lorsque celui-ci est sélectionné au clavier ou que la souris pointe dessus. L'élément qui déclenche l'info-bulle fait référence à l'élément d'info-bulle avec aria-describedby.

L'élément s'applique automatiquement le rôle tooltip et définit tabindex sur -1, car l'info-bulle elle-même ne peut jamais être mise au point.

Démo

Voir une démonstration en direct sur GitHub

Exemple d'utilisation

<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 {

Le constructeur effectue une tâche qui doit être exécutée exactement une seule fois.

  constructor() {
    super();

Ces fonctions sont utilisées dans de nombreux endroits et doivent toujours lier la référence correcte. Faites-le une fois.

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

connectedCallback() se déclenche lorsque l'élément est inséré dans le DOM. C'est un bon endroit pour définir le rôle initial, l'index de tabulation, l'état interne et installer des écouteurs d'événements.

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

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

    this._hide();

L'élément qui déclenche l'info-bulle fait référence à l'élément d'info-bulle avec aria-describedby.

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

L'info-bulle doit écouter les événements de mise au point/de floutage de la cible, ainsi que les événements de survol de la cible.

    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() désenregistre les écouteurs d'événements configurés dans connectedCallback().

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

Supprimez les écouteurs existants pour qu'ils ne se déclenchent pas même s'il n'y a pas d'info-bulle à afficher.

    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);