Panoramica del pacchetto @axe-core/watcher
Il pacchetto @axe-core/watcher è integrato nella tua suite di test per verificare gli errori di accessibilità
Panoramica della documentazione per Watcher
Le informazioni nella sezione *@axe-core/watcher * della documentazione sono le seguenti:
- Questo articolo, Panoramica, esamina il pacchetto @axe-core/watcher (chiamato anche Watcher o axe Watcher). Qui puoi trovare informazioni generali sul pacchetto, dove puoi scaricarlo, come installarlo e link ad altre risorse.
- Requisiti di sistema riguarda le versioni e le specifiche del software da utilizzare con Watcher.
- Gli articoli in Istruzioni JavaScript e Istruzioni TypeScript forniscono istruzioni per integrare Watcher con diversi framework di test e includono frammenti di esempio sia per JavaScript che per TypeScript. Si tratta delle stesse informazioni che vedi quando crei un progetto sul sito axe Developer Hub.
- Riferimento API fornisce una guida alle API fornite dal pacchetto @axe-core/watcher.
Cos'è Watcher?
Il pacchetto @axe-core/watcher consente di aggiungere facilmente test di accessibilità alla suite di test esistente. È un pacchetto Node.js disponibile su npmjs.com e attualmente funziona con i framework di test più diffusi. I test possono essere scritti in JavaScript o TypeScript.
Il pacchetto @axe-core/watcher, una volta integrato nella tua suite di test end-to-end:
- Aggiunge la convalida dell'accessibilità alla tua suite di test esistente con modifiche minime al codice, grazie a Watcher che avvolge i metodi importanti e le chiamate di funzione del tuo framework di test.(dh-glossary#wrapping)
- Analizza automaticamente le pagine web quando esegui la tua suite di test e rianalizza le pagine quando rileva qualsiasi modifica al DOM (ogni modifica è considerata uno stato di pagina separato): perfetto per app web con una sola pagina e altri siti complessi con pagine di accesso e altri contenuti dinamici.
- Collega i commit Git ai risultati di accessibilità per consentirti di valutare l'accessibilità di ogni commit e monitorare i progressi complessivi del tuo progetto in termini di accessibilità.
- Invia i risultati di accessibilità correlati a ogni stato di pagina e commit Git ad axe Developer Hub, dove i risultati vengono tracciati, deduplicati e presentati.
Come ottenere
L'ultima versione di @axe-core/watcher è disponibile su npmjs.com.
Installazione
Puoi installare il pacchetto nel tuo progetto Node.js come dipendenza di sviluppo con il seguente comando:
npm install --save-dev @axe-core/watcherRequisiti di sistema
Per i requisiti di sistema per @axe-core/watcher, vedere Requisiti di sistema.
Sebbene il sito Web axe Developer Hub supporti ampiamente i browser, solo Google Chrome è supportato dal pacchetto @axe-core/watcher per i test, quindi, ad esempio, non è possibile utilizzare il browser Electron predefinito di Cypress per eseguire i test.
Riferimento API
Per un riferimento alle API fornite dal pacchetto @axe-core/watcher, vedere Riferimento API.
Note di rilascio
Per informazioni sulle modifiche apportate a @axe-core/watcher, consultare le Note di rilascio di @axe-core/watcher.
Il repository degli esempi
Puoi sperimentare il codice nel repository degli esempi su GitHub. Contiene esempi per:
Istruzioni per la modifica della suite di test
La sezione istruzioni della documentazione include istruzioni per modificare la suite di test in modo da includere il pacchetto @axe-core/watcher.
Si tratta delle stesse istruzioni che vedi quando crei un nuovo progetto in axe Developer Hub.
Le sezioni seguenti contengono collegamenti alle istruzioni di ciascun framework di test: