Riepilogo
Un <howto-tooltip>
è un popup che mostra informazioni relative a un elemento quando l'elemento riceve lo stato attivo della tastiera o quando il mouse passa sopra l'elemento.
L'elemento che attiva la descrizione comando fa riferimento all'elemento della descrizione comando con
aria-describedby
.
L'elemento applica automaticamente il ruolo tooltip
e imposta tabindex
su -1, poiché la stessa ToolTip non può mai essere attivata.
Riferimento
- Istruzioni: Componenti su GitHub
- Pattern di descrizioni comando nelle Best practice per l'authoring ARIA 1.1
Demo
Visualizza la demo in tempo reale su GitHub
Esempio di utilizzo
<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>
Codice
class HowtoTooltip extends HTMLElement {
Il costruttore esegue un'operazione che deve essere eseguita esattamente una volta.
constructor() {
super();
Queste funzioni vengono utilizzate in molti punti e devono sempre associare il riferimento corretto, quindi esegui questa operazione una sola volta.
this._show = this._show.bind(this);
this._hide = this._hide.bind(this);
}
connectedCallback()
viene attivato quando l'elemento viene inserito nel DOM. È un buon punto di partenza per impostare il ruolo iniziale, l'indice tabulazione, lo stato interno e installare gli ascoltatori di eventi.
connectedCallback() {
if (!this.hasAttribute('role'))
this.setAttribute('role', 'tooltip');
if (!this.hasAttribute('tabindex'))
this.setAttribute('tabindex', -1);
this._hide();
L'elemento che attiva la descrizione comando fa riferimento all'elemento della descrizione comando con aria-describedby
.
this._target = document.querySelector('[aria-describedby=' + this.id + ']');
if (!this._target)
return;
La descrizione comando deve ascoltare gli eventi di messa a fuoco/offuscamento del target, nonché gli eventi di passaggio del mouse sopra il target.
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()
annulla la registrazione dei listener di eventi configurati in connectedCallback()
.
disconnectedCallback() {
if (!this._target)
return;
Rimuovi gli ascoltatori esistenti in modo che non vengano attivati anche se non è presente alcuna descrizione comando da mostrare.
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);