Utilizzo delle configurazioni globali

Link to Utilizzo delle configurazioni globali copied to clipboard

Questo articolo descrive come funziona la configurazione globale di axe Configuration con axe Developer Hub

Free Trial
Not for use with personal data

Panoramica delle configurazioni globali

Il pannello Globale di Configurazione axe fornisce un modo centralizzato per gestire e controllare le impostazioni dei test di accessibilità nell'intera organizzazione. Questa potente funzionalità consente agli amministratori aziendali di stabilire standard di test coerenti, offrendo al contempo ai singoli team e sviluppatori la flessibilità di cui hanno bisogno per lavorare in modo efficace.

Cosa sono le configurazioni globali?

Le configurazioni globali (scheda Globale della Configurazione di axe) sono un insieme di controlli che determinano il funzionamento di axe Developer Hub durante i test di accessibilità. Queste impostazioni includono:

  • Quali standard di accessibilità utilizzare per il test (ad esempio WCAG 2.1 AA o EN 301 549)
  • Se includere i controlli best practices
  • Se abilitare regole sperimentali
  • Quale versione di axe-core utilizzare per il test

Queste impostazioni possono essere gestite sia a livello aziendale che a livello di singolo utente, creando un ambiente di test flessibile ma controllato.

Perché utilizzare le configurazioni globali?

Le configurazioni globali risolvono diverse sfide comuni nei test di accessibilità aziendale:

  • Coerenza: assicurarsi che tutti i team eseguano i test in base agli stessi standard di accessibilità
  • Conformità: Applica requisiti di test specifici in tutta la vostra organizzazione
  • Flessibilità: Consente ai team di personalizzare il proprio approccio ai test entro parametri approvati
  • Controllo delle versioni: gestisci quali versioni di axe-core possono essere utilizzate nei progetti
  • Garanzia di qualità: Mantenere gli standard di test consentendo ottimizzazioni specifiche per il team

Come funzionano le configurazioni globali

Amministratori

Gli amministratori impostano i valori predefiniti per l'intera organizzazione e definiscono quali impostazioni gli utenti possono modificare tramite l'opzione configurationOverrides . Queste impostazioni stabiliscono la base di riferimento per i test di axe Developer Hub all'interno dell'organizzazione. Queste impostazioni vengono modificate nel pannello globale di Configurazione di axe.

note

Alcune impostazioni nel pannello globale al momento non si applicano ad axe Developer Hub. Queste impostazioni includono:

  • Il valore predefinito necessita di revisione
  • Schermate predefinite dei problemi condivisi
  • Apprendimento automatico predefinito
  • Servizio di utilizzo

Gli utenti

Invece di utilizzare il pannello Globale , i singoli utenti personalizzano la propria configurazione di test modificando o aggiungendo l' configurationOverrides opzione nel codice di configurazione dei test. L' configurationOverrides opzione interagisce con le impostazioni nel pannello globale come definito nella tabella in Configurazione globale comune e scenari di override della configurazione.

Il riferimento API include maggiori informazioni su configurationOverrides e sulle sue proprietà.

Scenari comuni di configurazione globale e di override della configurazione

Quando viene eseguito un test, axe Developer Hub unisce le impostazioni aziendali e utente per creare la configurazione di test finale. In questo modo si garantisce che tutte le personalizzazioni rimangano entro i parametri approvati, offrendo al contempo agli utenti la flessibilità necessaria.

Nella tabella seguente vengono illustrati gli scenari più comuni che si possono incontrare quando si lavora con configurazioni globali. Ogni scenario mostra come le impostazioni aziendali interagiscono con la configurazione del progetto.

Scenario Cosa vuoi fare Configurazione globale Il tuo codice di configurazione Risultato
Utilizzo di base Utilizza lo standard predefinito WCAG 2.0 AA (non modificabile nella configurazione globale) Nessuna configurazione specificata ✅ I test vengono eseguiti utilizzando WCAG 2.0 AA
Override consentito Utilizzare uno standard consentito diverso WCAG 2.0 AA, può utilizzare 2.1 AA configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} ✅ I test vengono eseguiti utilizzando WCAG 2.1 AA
Override non autorizzato Utilizzare uno standard non autorizzato Solo WCAG 2.0 AA configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } ❌ Errore: standard non consentito
Abilitare le migliori pratiche Includere controlli delle migliori pratiche Le migliori pratiche sono consentite configurationOverrides: { bestPractices: true } ✅ I test includono le migliori pratiche
Configurazione mista Utilizza regole personalizzate con lo standard WCAG 2.0 AA (non modificabile) runOptions: { rules: { 'color-contrast': { enabled: false } } } ⚠️ Funziona ma visualizza un avviso
Configurazione legacy Utilizzare la configurazione vecchio stile Qualunque runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } ⚠️ Funziona ma visualizza un avviso
Combinazione non valida Mescolare configurazioni vecchie e nuove Qualunque Utilizzando entrambi configurationOverrides e runOptions.runOnly ❌ Errore: impossibile utilizzare entrambi

Comprendere i risultati

  • ✅ Successo: la configurazione funziona come previsto
  • ⚠️ Attenzione: la configurazione funziona ma non è consigliata
  • ❌ Errore: la configurazione non andrà a buon fine

Raccomandazioni

  1. Preferire sempre configurationOverrides a runOptions.
  2. Prima di configurare gli override, controlla le impostazioni aziendali.
  3. Modificare le impostazioni solo quando necessario.
  4. Utilizza la configurazione più semplice che soddisfa le tue esigenze.

Esempio di sovrascrittura della configurazione

Ecco un esempio di configurazione che dimostra gli override per seguire WCAG 2.1 AA e le migliori pratiche:

const config = {
  axe: {
    apiKey: 'YOUR_API_KEY',

    configurationOverrides: {
      accessibilityStandard: 'WCAG 2.1 AA',
      axeCoreVersion: '4.9.1',
      experimentalRules: true,
      bestPractices: true
    }
};

Vedere ConfigurationOverrides Interface per una spiegazione delle proprietà.

Errori e avvisi

Errori

Standard non consentito

Se si tenta di utilizzare uno standard non consentito, verrà visualizzato il codice di risposta del server 422, Contenuto non elaborabile. Esempio di messaggio:

Error: Server responded to https://axe.deque.com/api-pub/watcher/sessions with status code 422: "error": "Invalid accessibility standard: WCAG 2.0 AA. Allowed options: EN 301 549, Trusted Tester v5"
Utilizzo runOptions.runOnly con configurationOverrides

Se si utilizzano entrambi runOptions.runOnly con configurationOverrides, i test falliranno immediatamente. Usa solo configurationOverrides.

Avvisi

Utilizzando runOptions.runOnly

Se utilizzi runOptions.runOnly nella tua configurazione, riceverai questo messaggio di avviso:

Screenshot che mostra un avviso in axe Developer Hub relativo all'utilizzo di runOptions.runOnly.

@axe-core/watcher Senza supporto di configurazione globale

Se si utilizza una versione di @axe-core/watcher troppo vecchia per supportare la configurazione globale, verrà visualizzato il seguente messaggio:

Screenshot che mostra il messaggio che si verifica quando il pacchetto @axe-core/watcher è troppo vecchio per supportare le configurazioni globali

Vedere anche