Riepilogo
<howto-checkbox>
rappresenta un'opzione booleana in un modulo. Il tipo più comune
della casella di controllo è un doppio tipo che consente all'utente di passare
scelte: selezionate e deselezionate.
L'elemento cerca di applicare automaticamente gli attributi role="checkbox"
e
tabindex="0"
alla prima creazione. L'attributo role
facilita l'accessibilità
come uno screen reader che indicano all'utente il tipo di controllo.
L'attributo tabindex
attiva l'elemento nell'ordine del tabulazione, facendolo diventare tastiera
attivabile e azionabile. Per saperne di più su questi due argomenti, dai un'occhiata
Che cosa può fare ARIA? e Usare tabindex.
Quando la casella di controllo è selezionata, viene aggiunto un attributo booleano checked
e imposta
una proprietà checked
corrispondente a true
. Inoltre, l'elemento imposta un parametro
aria-checked
a "true"
o "false"
, a seconda del relativo
stato. Facendo clic sulla casella di controllo con il mouse o la barra spaziatrice, vengono attivati/disattivati questi elementi
selezionati.
La casella di controllo supporta anche uno stato disabled
. Se la proprietà disabled
è impostato su true o viene applicato l'attributo disabled
, le caselle di controllo vengono impostate
aria-disabled="true"
, rimuove l'attributo tabindex
e restituisce lo stato attivo
al documento se la casella di controllo è activeElement
corrente.
La casella di controllo è associata a un elemento howto-label
per garantire che abbia un
nome accessibile.
Riferimento
- HowTo: componenti su GitHub
- Pattern casella di controllo nelle pratiche di creazione di ARIA 1.1
- Che cosa può fare ARIA?
- Utilizzare tabindex
Demo
Visualizza la demo live su GitHub
Esempio di utilizzo
<style>
howto-checkbox {
vertical-align: middle;
}
howto-label {
vertical-align: middle;
display: inline-block;
font-weight: bold;
font-family: sans-serif;
font-size: 20px;
margin-left: 8px;
}
</style>
<howto-checkbox id="join-checkbox"></howto-checkbox>
<howto-label for="join-checkbox">Join Newsletter</howto-label>
Codice
(function() {
Definisci i codici dei tasti per semplificare la gestione degli eventi della tastiera.
const KEYCODE = {
SPACE: 32,
};
La clonazione dei contenuti da un elemento <template>
ha prestazioni migliori rispetto all'utilizzo di innerHTML perché evita costi aggiuntivi di analisi HTML.
const template = document.createElement('template');
template.innerHTML = `
<style>
:host {
display: inline-block;
background: url('../images/unchecked-checkbox.svg') no-repeat;
background-size: contain;
width: 24px;
height: 24px;
}
:host([hidden]) {
display: none;
}
:host([checked]) {
background: url('../images/checked-checkbox.svg') no-repeat;
background-size: contain;
}
:host([disabled]) {
background:
url('../images/unchecked-checkbox-disabled.svg') no-repeat;
background-size: contain;
}
:host([checked][disabled]) {
background:
url('../images/checked-checkbox-disabled.svg') no-repeat;
background-size: contain;
}
</style>
`;
class HowToCheckbox extends HTMLElement {
static get observedAttributes() {
return ['checked', 'disabled'];
}
Il costruttore dell'elemento viene eseguito ogni volta che viene creata una nuova istanza. Le istanze vengono create analizzando l'HTML, chiamando document.createElement('howto-checkbox') o chiamando new HowToCheckbox() Il costruttore è un buon posto per creare shadow DOM, anche se dovresti evitare di toccare attributi o elementi figlio DOM luce, poiché potrebbero non essere ancora disponibili.
constructor() {
super();
this.attachShadow({mode: 'open'});
this.shadowRoot.appendChild(template.content.cloneNode(true));
}
connectedCallback()
si attiva quando l'elemento viene inserito nel DOM. È un buon posto per impostare i listener di eventi role
, tabindex
, dello stato interno e di installazione iniziali.
connectedCallback() {
if (!this.hasAttribute('role'))
this.setAttribute('role', 'checkbox');
if (!this.hasAttribute('tabindex'))
this.setAttribute('tabindex', 0);
Un utente può impostare una proprietà su un'istanza di un elemento prima che il relativo prototipo venga collegato a questa classe. Il metodo _upgradeProperty()
controllerà le proprietà dell'istanza e le eseguirà attraverso i setter delle classi appropriati. Per ulteriori dettagli, consulta la sezione sulle proprietà lazy.
this._upgradeProperty('checked');
this._upgradeProperty('disabled');
this.addEventListener('keyup', this._onKeyUp);
this.addEventListener('click', this._onClick);
}
_upgradeProperty(prop) {
if (this.hasOwnProperty(prop)) {
let value = this[prop];
delete this[prop];
this[prop] = value;
}
}
disconnectedCallback()
si attiva quando l'elemento viene rimosso dal DOM. È un buon posto per eseguire operazioni di pulizia come rilasciare riferimenti e rimuovere i listener di eventi.
disconnectedCallback() {
this.removeEventListener('keyup', this._onKeyUp);
this.removeEventListener('click', this._onClick);
}
Le proprietà e gli attributi corrispondenti devono essere speculari. Il setter della proprietà per la casella selezionata gestisce i valori di verità/falsi e li riflette allo stato dell'attributo. Consulta la sezione Evita nuovi accessi per maggiori dettagli.
set checked(value) {
const isChecked = Boolean(value);
if (isChecked)
this.setAttribute('checked', '');
else
this.removeAttribute('checked');
}
get checked() {
return this.hasAttribute('checked');
}
set disabled(value) {
const isDisabled = Boolean(value);
if (isDisabled)
this.setAttribute('disabled', '');
else
this.removeAttribute('disabled');
}
get disabled() {
return this.hasAttribute('disabled');
}
attributeChangedCallback()
viene chiamato quando viene modificato uno qualsiasi degli attributi nell'array LookerAttributes. È un ottimo posto per gestire effetti collaterali, come l'impostazione di attributi ARIA.
attributeChangedCallback(name, oldValue, newValue) {
const hasValue = newValue !== null;
switch (name) {
case 'checked':
this.setAttribute('aria-checked', hasValue);
break;
case 'disabled':
this.setAttribute('aria-disabled', hasValue);
L'attributo tabindex
non fornisce un modo per rimuovere completamente la attivabilità da un elemento. Gli elementi con tabindex=-1
possono comunque essere attivati con il mouse o chiamando focus()
. Per assicurarti che un elemento sia disattivato e che non sia attivabile, rimuovi l'attributo tabindex
.
if (hasValue) {
this.removeAttribute('tabindex');
Se lo stato attivo è attualmente su questo elemento, disattivalo chiamando il metodo HTMLElement.blur()
this.blur();
} else {
this.setAttribute('tabindex', '0');
}
break;
}
}
_onKeyUp(event) {
Non gestire i tasti di modifica utilizzati in genere dalle tecnologie per la disabilità.
if (event.altKey)
return;
switch (event.keyCode) {
case KEYCODE.SPACE:
event.preventDefault();
this._toggleChecked();
break;
Qualsiasi altra pressione del tasto viene ignorata e restituita al browser.
default:
return;
}
}
_onClick(event) {
this._toggleChecked();
}
_toggleChecked()
chiama il setter selezionato e capovolge il proprio stato. Poiché _toggleChecked()
è causato solo da un'azione dell'utente, invierà anche un evento di modifica. Questo evento mostra le bolle per imitare il comportamento nativo di <input type=checkbox>
.
_toggleChecked() {
if (this.disabled)
return;
this.checked = !this.checked;
this.dispatchEvent(new CustomEvent('change', {
detail: {
checked: this.checked,
},
bubbles: true,
}));
}
}
customElements.define('howto-checkbox', HowToCheckbox);
})();