مكونات طريقة التنفيذ – تلميح بشأن الطريقة

إيوا غاسبيرويكز

روب دودسون

سوما

ملخّص

<howto-tooltip> هي نافذة منبثقة تعرض معلومات ذات صلة بعنصر عندما يتلقّى العنصر تركيز لوحة المفاتيح أو عندما يحرك الماوس فوقه. يشير العنصر الذي يؤدي إلى ظهور التلميح إلى عنصر التلميح aria-describedby.

يطبِّق العنصر الدور tooltip ذاتيًا ويضبط tabindex على -1، لأنّه لا يمكن أبدًا التركيز على التلميح نفسه.

مَراجع

• طريقة التنفيذ: المكوّنات على GitHub
• نمط التلميح في الإصدار 1.1 من "ممارسات تأليف ARIA"

تجريبي

مشاهدة العرض التوضيحي المباشر على 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. وهو مكان جيد لتحديد الدور الأولي ومؤشر التبويب والحالة الداخلية وأدوات معالجة الأحداث.

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