如何使用元件 – 操作說明工具提示

Ewa Gasperowicz
X
Rob Dodson
Surma

摘要

<howto-tooltip> 是彈出式視窗，會在元素收到鍵盤焦點或滑鼠游標懸停在元素上時，顯示與元素相關的資訊。觸發工具提示的元素會使用 aria-describedby 參照工具提示元素。

由於工具提示本身無法取得焦點，因此元素會自行套用 tooltip 角色，並將 tabindex 設為 -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);
}

當元素插入 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);