Компоненты HowTo – всплывающая подсказка

Ewa Gasperowicz

Rob Dodson

Surma

Краткое содержание

<howto-tooltip> — это всплывающее окно, которое отображает информацию, связанную с элементом, когда элемент получает фокус клавиатуры или наводит на него курсор мыши. Элемент, вызывающий всплывающую подсказку, ссылается на элемент всплывающей подсказки с помощью aria-describedby .

Элемент самостоятельно применяет tooltip роли и устанавливает для tabindex значение -1, поскольку сама всплывающая подсказка никогда не может быть сфокусирована.

Ссылка

• HowTo: Компоненты на GitHub
• Шаблон всплывающей подсказки в ARIA Authoring Practices 1.1

Демо

Посмотреть живую демонстрацию на GitHub

Пример использования

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

Код

class HowtoTooltip extends HTMLElement {

Конструктор выполняет работу, которую необходимо выполнить ровно один раз.

  constructor() {
    super();

Эти функции используются во многих местах, и всегда необходимо привязать правильную ссылку, поэтому сделайте это один раз.

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

connectedCallback() срабатывает, когда элемент вставляется в DOM. Это хорошее место для установки начальной роли, tabindex, внутреннего состояния и установки прослушивателей событий.

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

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

    this._hide();

Элемент, вызывающий всплывающую подсказку, ссылается на элемент всплывающей подсказки с помощью aria-describedby .

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

Всплывающая подсказка должна прослушивать события фокусировки/размытия от цели, а также события наведения на цель.

    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() отменяет регистрацию прослушивателей событий, которые были настроены в connectedCallback() .

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

Удалите существующие прослушиватели, чтобы они не запускались, даже если всплывающая подсказка не отображается.

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