Componentes de HowTo: información sobre la herramienta

Ewa Gasperowicz
X
Rob Dodson
Surma

Resumen

Un <howto-tooltip> es una ventana emergente que muestra información relacionada con un elemento cuando este recibe el enfoque del teclado o cuando se coloca el cursor del mouse sobre él. El elemento que activa el cuadro de información hace referencia al elemento del cuadro de información con aria-describedby.

El elemento aplica la función tooltip por cuenta propia y establece tabindex en -1, ya que la información sobre la herramienta nunca se puede enfocar.

Referencia

Demostración

Ver la demostración en vivo en GitHub

Ejemplo de uso

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

Código

class HowtoTooltip extends HTMLElement {

El constructor hace un trabajo que se debe ejecutar exactamente una vez.

  constructor() {
    super();

Estas funciones se usan en muchos lugares y siempre deben vincular la referencia correcta, así que hazlo una vez.

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

connectedCallback() se activa cuando se inserta el elemento en el DOM. Es un buen lugar para configurar el rol inicial, el tabindex, el estado interno y los objetos de escucha de eventos de instalación.

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

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

    this._hide();

El elemento que activa el cuadro de información hace referencia al elemento del cuadro de información con aria-describedby.

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

La información sobre herramientas debe escuchar los eventos de enfoque o desenfoque del objetivo, así como los eventos de desplazamiento sobre el objetivo.

    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() cancela el registro de los objetos de escucha de eventos que se configuraron en connectedCallback().

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

Quita los objetos de escucha existentes de modo que no se activen aunque no haya información sobre la herramienta para mostrar.

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