HowTo 组件 - howto-tooltip

Ewa Gasperowicz

Rob Dodson

Surma

摘要

<howto-tooltip> 是一种弹出式窗口，当元素获得键盘焦点或鼠标悬停在元素上时，会显示与元素相关的信息。触发提示的元素使用 aria-describedby 引用提示元素。

该元素会自行应用角色 tooltip 并将 tabindex 设置为 -1，因为提示框本身永远无法获得焦点。

参考

• HowTo：GitHub 上的组件
• 《ARIA 编写实践指南 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 引用，因此请只绑定一次。

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

当元素插入 DOM 时，connectedCallback() 会触发。这是设置初始角色、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);