Riferimento API Cypress per axe DevTools per Web
Riferimento per le API nel pacchetto @axe-devtools/cypress
Cypress Chainable Commands (analyze)
cy.axeAnalyze()
Questo comando concatenabile inietta axe in tutte le pagine e gli iframe e poi viene eseguito axe sulla pagina.
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| Contesto (facoltativo) | axe.ElementContext | non definito | Definisce l'ambito dell'analisi, ovvero la parte del DOM che si desidera analizzare. In genere si tratterà del documento o di un selettore specifico, come il nome della classe, l'ID, il selettore, ecc. |
| Opzioni (facoltativo) | axe.RunOptions | non definito | Insieme di opzioni passate alle regole o ai controlli, modificandoli temporaneamente. Ciò contrasta con axe.configure, che è più permanente. |
| log (facoltativo) | Booleano | falso | Restituisce l'output su stdout con il numero di elementi non accessibili e l'impatto della violazione come tabella. |
cy.isAxeClean()
Questo comando concatenabile è un'affermazione che la pagina non presenta violazioni di accessibilità.
Parametri:
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| Contesto (facoltativo) | axe.ElementContext | non definito | Definisce l'ambito dell'analisi, ovvero la parte del DOM che si desidera analizzare. In genere si tratterà del documento o di un selettore specifico, come il nome della classe, l'ID, il selettore, ecc. |
| Opzioni (facoltativo) | axe.RunOptions | non definito | Insieme di opzioni passate alle regole o ai controlli, modificandoli temporaneamente. Ciò contrasta con axe.configure, che è più permanente. |
Cypress Chainable Commands (configuration)
Integra axe DevTools for Web con Cypress utilizzando comandi Cypress concatenabili personalizzati per configurare i risultati analizzati.
cy.setAxeSource()
Questo comando concatenabile imposta la versione di axe.
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| Percorso del file (obbligatorio) | String | null | Percorso relativo alla radice del progetto che dovrebbe includere una versione minimizzata di axe. axe.source |
cy.setAxeCustom()
Questo comando concatenabile consente l'utilizzo di set di regole personalizzati.
- axe DevTools per Web Cypress leggerà implicitamente quando posizionato al livello radice del progetto, o utilizzerà file di set di regole personalizzati quando la variabile d'ambiente è impostata.
axe-ruleset.jsonAXE_RULESET_PATH
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| Percorso del file (obbligatorio) | String | null | Percorso relativo alla radice del progetto che dovrebbe includere controlli e regole |
cy.setAxeRuleset()
Questo comando concatenabile consente agli utenti di eseguire regole per tag, in modo simile alla configurazione axe.run().
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| Set di regole (obbligatorio) | '508', 'en301549', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa' | 'wcag2.1' | Array di tag a cui è assegnata questa regola. |
cy.setAxeReportName()
Questo comando concatenabile consente agli utenti di impostare il nome del file di report.
| Parametro | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| reportName (obbligatorio) | String | @axe-devtools-cypress | Nome del file del report. |
cy.getAxeResults()
Questo comando concatenabile consente agli utenti di utilizzare i risultati dopo l'esecuzione cy.axeAnalyze()[inserire il contenuto appropriato qui].
Le risposte da getAxeResults() restituiscono la forma dei dati axe.AxeResults.
Esempio:
after(() => {
cy.axeAnalyze();
cy.getAxeResults().then(data => {
cy.writeFile('./results.json', data)
})
})Servizio di utilizzo
Il servizio di utilizzo ti consente di ottenere informazioni sulle tendenze di utilizzo di axe DevTools for Web all'interno della tua organizzazione.
Variabili d'ambiente
Questo metodo consente agli utenti di modificare valori specifici del servizio di utilizzo tramite variabili di ambiente
| Variabile d'ambiente | Tipo |
|---|---|
| AXE_IS_LOGGED_IN | Booleano |
| AXE_KEYCLOAK_ID | String |
| AXE_UTENTE_ID | String |
| AXE_SESSIONE_ID | String |
| STATO_UTENTE_AXE | String |
| RUOLO_PROFESSIONE_UTENTE_AXE | String |
| AXE_DISTINTO_ID | String |
| ISTANZA_DEV_IS_AXE | Booleano |
| AXE_ORGANIZZAZIONE | String |
| AXE_APPLICAZIONE | String |
| AXE_METRICS_URL | String |
| AXE_TRACK_USAGE | Booleano |
cy.task('enableTracking', <boolean>)
Questa attività di Cypress consente agli utenti di scegliere di inviare dati al servizio di utilizzo.
cy.task('setTrackingUrl', <string>)
Questa attività Cypress consente agli utenti di modificare la destinazione dei dati delle metriche di utilizzo.
cy.task('setDistinctId', <string>)
Questa attività Cypress consente agli utenti di modificare l'ID univoco memorizzato o utilizzato.
Prossimi passi
In caso di problemi durante l'installazione di axe DevTools per Web, contatta direttamente il tuo rappresentante Deque, chiedi informazioni tramite il nostro support desk oppure inviaci un'e-mail. Saremo lieti di aiutarti a metterti in moto.