רכיבי HowTo – מדריך קצר

סיכום

<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 מבצע עבודה שצריך לבצע רק פעם אחת.

  constructor() {
    super();

הפונקציות האלה משמשות במספר מקומות, ותמיד צריך לקשר את ההפניה הנכונה של this, לכן צריך לעשות זאת פעם אחת.

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

האירוע connectedCallback() מופעל כשהרכיב מוכנס ל-DOM. זהו מקום טוב להגדיר בו את התפקיד הראשוני, את מדד הטאבים, את המצב הפנימי ולהתקין פונקציות event listener.

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