Classe ConfigurationOverrides

A classe ConfigurationOverrides permite que você sobrescreva as configurações globais configuração do axe para teste de acessibilidade com o axe Watcher. Você pode usar esta classe para personalizar os padrões de acessibilidade, habilitar as melhores práticas e regras experimentais, e especificar a versão do axe-core a ser usada durante o teste.

Essas sobrescrições têm precedência sobre as configurações globais definidas na sua Conta do axe.

Construtor

ConfigurationOverrides()

Cria uma nova instância de ConfigurationOverrides com configurações padrão (todas as propriedades definidas para null).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Métodos

setEnableBestPractices(boolean enableBestPractices)

Habilita ou desabilita regras de melhores práticas durante o teste de acessibilidade. As regras de melhores práticas identificam problemas que não são estritamente exigidos pelos padrões de acessibilidade, mas que podem melhorar a experiência do usuário.

Parâmetros:

• enableBestPractices - Valor booleano que indica se as regras de melhores práticas devem ser habilitadas

Retorna:

• ConfigurationOverrides - A instância atual para encadeamento de métodos

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableBestPractices(true);

setEnableExperimental(boolean enableExperimental)

Habilita ou desabilita regras experimentais durante o teste de acessibilidade. As regras experimentais são regras novas ou instáveis que ainda estão em desenvolvimento.

Parâmetros:

• enableExperimental - Valor booleano que indica se as regras experimentais devem ser habilitadas

Retorna:

• ConfigurationOverrides - A instância atual para encadeamento de métodos

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableExperimental(false);

setAccessibilityStandard(AccessibilityStandard standard)

Define o padrão de acessibilidade a ser usado para teste. Isso determina qual conjunto de regras de acessibilidade são aplicadas durante o teste.

Parâmetros:

• standard - Um valor de enumeração AccessibilityStandard que especifica o padrão a ser usado

Retorna:

• ConfigurationOverrides - A instância atual para encadeamento de métodos

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);

setAxeCoreVersion(String axeCoreVersion)

Define a versão do axe-core a ser usada para teste. Isso permite que você especifique uma versão específica ou use a versão mais recente.

Parâmetros:

• axeCoreVersion - A string de versão do axe-core a ser usada (por exemplo, "4.6.0" ou "latest")

Retorna:

• ConfigurationOverrides - A instância atual para encadeamento de métodos

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAxeCoreVersion("4.7.0");

getEnableBestPractices()

Obtém a configuração atual para habilitar as regras de melhores práticas.

Retorna:

• Boolean - A configuração atual para habilitar as regras de melhores práticas

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableBestPractices(true);
Boolean enableBestPractices = configOverrides.getEnableBestPractices(); // Returns true

getEnableExperimental()

Obtém a configuração atual para habilitar as regras experimentais.

Retorna:

• Boolean - A configuração atual para habilitar as regras experimentais

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setEnableExperimental(false);
Boolean enableExperimental = configOverrides.getEnableExperimental(); // Returns false

getAccessibilityStandard()

Obtém a configuração atual do padrão de acessibilidade.

Retorna:

• String - A configuração atual do padrão de acessibilidade

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG21AA);
String standard = configOverrides.getAccessibilityStandard(); // Returns "WCAG 2.1 AA"

getAxeCoreVersion()

Obtém a configuração da versão atual do axe-core.

Retorna:

• String - A configuração atual da versão do axe-core

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();
configOverrides.setAxeCoreVersion("4.7.0");
String version = configOverrides.getAxeCoreVersion(); // Returns "4.7.0"

toJson()

Serializa a instância ConfigurationOverrides para uma string JSON.

Retorna:

• String - Uma representação em string JSON das substituições de configuração

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides()
    .setEnableBestPractices(true)
    .setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);
String json = configOverrides.toJson();
// Returns: {"best_practices":true,"experimental_rules":null,"accessibility_standard":"WCAG 2.2 AA","axe_core_version":null}

Enumeração AccessibilityStandard

A classe ConfigurationOverrides inclui uma enumeração AccessibilityStandard que define os padrões de acessibilidade disponíveis:

Valores da Enumeração

• WCAG2A - WCAG 2.0 Nível A
• WCAG2AA - WCAG 2.0 Nível AA
• WCAG2AAA - WCAG 2.0 Nível AAA
• WCAG21A - WCAG 2.1 Nível A
• WCAG21AA - WCAG 2.1 Nível AA
• WCAG21AAA - WCAG 2.1 Nível AAA
• WCAG22A - WCAG 2.2 Nível A
• WCAG22AA - WCAG 2.2 Nível AA
• WCAG22AAA - WCAG 2.2 Nível AAA
• TTV5 - Trusted Tester v5
• EN301549 - EN 301 549
• RGAAV4 - RGAA versão 4 (padrão de acessibilidade francês; requer axe-core 4.11.0 ou posterior)
• ALL - Todos os padrões

Exemplo:

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

// Set to WCAG 2.2 Level AA
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.WCAG22AA);

// Set to Trusted Tester v5
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.TTV5);

// Set to all standards
configOverrides.setAccessibilityStandard(ConfigurationOverrides.AccessibilityStandard.ALL);

Notas Importantes

1. Configurações Mutuamente Exclusivas: Você não pode usar configurationOverrides.accessibilityStandard e runOptions.runOnly ao mesmo tempo.

2. Propriedades Nulas: Todas as propriedades em ConfigurationOverrides têm padrão null. Quando uma propriedade é null, a configuração global do axe Developer Hub é usada em seu lugar.

3. Precedência: As substituições de configuração têm precedência sobre as configurações globais em sua conta axe, permitindo personalizar testes para conjuntos ou execuções de teste específicas.

4. Serialização: O método toJson() inclui valores nulos na saída, tornando a estrutura JSON consistente, independentemente de quais propriedades estão definidas.

Veja Também

• AxeWatcherOptions
• AxeWatcher
• AxeRunOptions
• AxeRunOnly