Componentes de instruções – dica de ferramenta

Ewa Gasperowicz
X
Rob Dodson
Surma

Resumo

Um <howto-tooltip> é um pop-up que mostra informações relacionadas a um elemento quando ele recebe o foco do teclado ou quando o mouse passa por ele. O elemento que aciona a dica faz referência ao elemento da dica com aria-describedby.

O elemento aplica a função tooltip e define tabindex como -1, já que a tooltip em si nunca pode ser focada.

Referência

Demonstração

Conferir a demonstração ao vivo no GitHub

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

O construtor faz o trabalho que precisa ser executado exatamente uma vez.

  constructor() {
    super();

Essas funções são usadas em vários lugares e sempre precisam vincular a referência correta. Faça isso uma vez.

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

connectedCallback() é acionado quando o elemento é inserido no DOM. É um bom lugar para definir o papel inicial, o tabindex, o estado interno e instalar listeners de eventos.

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

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

    this._hide();

O elemento que aciona a dica de ferramenta faz referência ao elemento de dica de ferramenta com aria-describedby.

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

A dica precisa detectar eventos de foco/desfoque do destino, bem como eventos de passar o cursor sobre o destino.

    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() desregistra os listeners de eventos configurados em connectedCallback().

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

Remova os listeners atuais para que eles não sejam acionados, mesmo que não haja uma dica de ferramenta 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);