Axe DevTools per Web Cucumber

La gemma fornisce definizioni di passaggi personalizzati per valutare se una determinata pagina è axe clean. axe-devtools-cucumber

Questa gem amplia i passaggi forniti nel file readme della gem axe-core-cucumber.

Configurazione e utilizzo

Assicurati di avere accesso al [registro di Deque][configurazione del registro npm di attest]. In caso contrario, [fare riferimento alla configurazione][].

• Aggiungi axe-devtools-cucumber al tuo file Gemfile o gemspec ed esegui bundle install.

gem "axe-devtools-cucumber"

spec.add_dependency "axe-devtools-cucumber"

• Richiedere le definizioni dei passaggi offerte dalla gem. In genere, è possibile farlo aggiungendolo a un file di installazione di Cucumber esistente in features/support/env.rb.

require 'axe-cucumber-steps'

• Da utilizzare con i [WebDriver][axe devtools gem] di propria scelta.

API

Passo - Be axe Clean (be axe clean)

Il passaggio be axe clean è la componente fondamentale dell'integrazione. Si tratta di un passaggio completo di per sé e verificherà che la pagina attualmente caricata sia pulita axe clean utilizzando la configurazione predefinita di axe.run (l'intero documento viene controllato utilizzando le regole predefinite).

Then the page should be axe clean

Fase - Essere verificato per l'accessibilità (be audited for accessibility)

Questo passaggio ti consente di verificare l'accessibilità del tuo sito senza far fallire la serie di test. Per gli identificati violations i corrispondenti convertiranno l'esempio di test in pending e produrranno in output le violazioni dettagliate.

Then the page should be audited for accessibility [including]
[excluding] [according to/according to ruleset] [checking rules/checking-only-rules]
[skipping rules] [logging results for]

Clausole

Le clausole sono metodi concatenabili per le definizioni dei passaggi be axe clean e be audited for accessibility .

Le clausole configurabili consentono una maggiore granularità nei test e nelle aspettative.

within- Clausola di inclusione

La clausola di inclusione (within "#selector") specifica quali elementi della pagina devono essere controllati. È necessario fornire un selettore CSS valido, racchiuso tra virgolette doppie. I selettori composti possono essere utilizzati per selezionare più elementi, ad esempio within "#header, .footer". Per ulteriori informazioni, vedere la [documentazione del parametro context][context-param].

Then the page should be axe clean within "#selector"

excluding- Clausola di esclusione

La clausola di esclusione (excluding "#selector") specifica quali elementi del documento devono essere ignorati. È necessario fornire un selettore CSS valido, racchiuso tra virgolette doppie. I selettori composti possono essere utilizzati per selezionare più elementi, ad esempio excluding "#widget, .ad". Per ulteriori informazioni, vedere la [documentazione del parametro context][context-param].

Then the page should be audited for accessibility excluding "#selector"

Se lo si desidera, è possibile utilizzare un punto e virgola (;) o la parola but per separare la clausola di esclusione da quella di inclusione (se presente).

Then the page should be audited for accessibility within "main"; excluding "aside"
Then the page should be axe clean within "main" but excluding "aside"

according to- Clausola dello standard di accessibilità (Etichetta)

La clausola tag specifica quale standard di accessibilità (o quali standard) devono essere utilizzati per controllare la pagina. Gli standard di accessibilità sono specificati tramite nome (tag). È possibile specificare più standard separati da virgole, ad esempio according to: wcag2a, section508. Sono documentati [i nomi dei tag accettabili][options-param] nonché un [elenco completo delle regole][rules] che corrispondono a ciascun tag.

Then the page should be audited for accessibility according to: tag-name

Se lo si desidera, è possibile utilizzare un punto e virgola (;) per separare la clausola tag dalla clausola precedente.

Then the page should be axe clean within "#header"; according to: best-practice

checking- Clausola di controllo delle regole

La clausola checking-rules specifica quali regole aggiuntive eseguire (oltre ai tag specificati, se presenti, o al set di regole predefinito). Le regole sono specificate da ID regola separati da virgole.

Then the page should be axe clean checking: ruleId

Per un elenco degli ID regola validi, vedere la documentazione delle regole.

Se lo si desidera, è possibile utilizzare un punto e virgola (;) o la parola and per separare la clausola 'checking-rules' dalla clausola precedente.

Then the page should be axe clean according to: wcag2a; checking: color-contrast
Then the page should be audited for accessibility according to: wcag2a and checking: color-contrast

checking only- Clausola di regole esclusive

Questa clausola non è propriamente una clausola separata. Ma piuttosto, aggiungendo la parola only alla clausola checking-rules, il significato del passaggio può essere modificato. Come descritto sopra, per impostazione predefinita la clausola delle regole di controllo specifica regole aggiuntive da eseguire. Se la parola only viene utilizzata, vengono controllate solo le regole specificate.

Then the page should be axe clean checking only: ruleId

skipping- Clausola di esclusione delle regole

La clausola skipping-rules specifica quali regole ignorare. Ciò consente di fornire uno standard di accessibilità (tramite la clausola tag) ignorando una regola particolare. Le regole sono specificate da ID regola separati da virgole.

Then the page should be audited for accessibility skipping: ruleId

Per un elenco degli ID regola validi, vedere la documentazione delle regole.

È possibile utilizzare un punto e virgola (;) o la parola "o" but per separare la clausola per ignorare le regole dalla clausola precedente, come mostrato di seguito:

Then the page should be axe clean according to: wcag2a; skipping: accesskeys
Then the page should be audited for accessibility according to: wcag2a but skipping: accesskeys

Clausole disponibili solo per il passaggio - Essere sottoposto a verifica per l'accessibilità

Il be audited for accessibility matcher fornisce supporto per due clausole aggiuntive.

according to ruleset- Clausola dell'insieme di regole

La clausola dell'insieme di regole [according to ruleset] consente di specificare un singolo insieme di regole (ad esempio, 508, wcag2, wcag21) da utilizzare per controllare la pagina.

Then the page should be axe clean according to ruleset: wcag2

logging results- Clausola di registrazione dei risultati

Per registrare i risultati del matcher di base e delle clausole, richiamare il metodo concatenabile logging results come mostrato di seguito. La clausola logging results for: report_name consente di specificare il nome del report generato al termine dell'esecuzione del passo.

Then the page should be audited for accessibility logging results for: axe_report_of_my_site

Interoperabilità tra le clausole

Tutte le clausole descritte possono essere combinate e abbinate tramite method chaining. Di seguito alcuni esempi.

Then the page should be audited for accessibility within "main, header" but excluding "footer"

Then the page should be axe clean excluding "#sidebar" according to: wcag2a, wcag2aa but skipping: color-contrast

Then the page should be audited for accessibility checking only: document-title, label

Then the page should be axe clean according to: best-practice and checking: aria-roles, definition-list

Utilizzo avanzato dell'API

Fare riferimento a [utilizzo avanzato][] per vedere come configurare l'API per:

• Regole personalizzate
• Percorso personalizzato per la sorgente di axe
• Registrazione dell'utilizzo
• Rapporti