Clase ConfigurationOverrides

La clase ConfigurationOverrides te permite anular configuración de axe los ajustes globales para las pruebas de accesibilidad con axe Watcher. Puedes usar esta clase para personalizar los estándares de accesibilidad, habilitar las mejores prácticas y las reglas experimentales, y especificar la versión de axe-core a utilizar durante las pruebas.

Estas anulaciones tienen prioridad sobre los ajustes de configuración global definidos en tu Cuenta de axe.

Constructor

ConfigurationOverrides()

Crea una nueva instancia de ConfigurationOverrides con los ajustes predeterminados (todas las propiedades establecidas en null).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Métodos

setEnableBestPractices(boolean enableBestPractices)

Habilita o deshabilita las reglas de mejores prácticas durante las pruebas de accesibilidad. Las reglas de mejores prácticas identifican problemas que no son estrictamente requeridos por los estándares de accesibilidad pero que pueden mejorar la experiencia del usuario.

Parámetros:

• enableBestPractices - Valor booleano que indica si habilitar las reglas de mejores prácticas

Devuelve:

• ConfigurationOverrides - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setEnableExperimental(boolean enableExperimental)

Habilita o deshabilita las reglas experimentales durante las pruebas de accesibilidad. Las reglas experimentales son reglas nuevas o inestables que aún están en desarrollo.

Parámetros:

• enableExperimental - Valor booleano que indica si habilitar las reglas experimentales

Devuelve:

• ConfigurationOverrides - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setAccessibilityStandard(AccessibilityStandard standard)

Establece el estándar de accesibilidad a utilizar para las pruebas. Esto determina qué conjunto de reglas de accesibilidad se aplican durante las pruebas.

Parámetros:

• standard - Un valor de enumeración AccessibilityStandard que especifica el estándar a utilizar

Devuelve:

• ConfigurationOverrides - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setAxeCoreVersion(String axeCoreVersion)

Establece la versión de axe-core a utilizar para las pruebas. Esto te permite especificar una versión específica o usar la última versión.

Parámetros:

• axeCoreVersion - La cadena de versión de axe-core a utilizar (por ejemplo, "4.6.0" o "latest")

Devuelve:

• ConfigurationOverrides - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

getEnableBestPractices()

Obtiene la configuración actual para habilitar las reglas de mejores prácticas.

Devuelve:

• Boolean - La configuración actual para habilitar las reglas de mejores prácticas

Ejemplo:

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

getEnableExperimental()

Obtiene la configuración actual para habilitar las reglas experimentales.

Devuelve:

• Boolean - La configuración actual para habilitar las reglas experimentales

Ejemplo:

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

getAccessibilityStandard()

Obtiene la configuración actual del estándar de accesibilidad.

Devuelve:

• String - La configuración actual del estándar de accesibilidad

Ejemplo:

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

getAxeCoreVersion()

Obtiene la configuración actual de la versión de axe-core.

Devuelve:

• String - La configuración actual de la versión de axe-core

Ejemplo:

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

toJson()

Serializa la instancia de ConfigurationOverrides en una cadena JSON.

Devuelve:

• String - Una representación en cadena JSON de las configuraciones de sobrescritura

Ejemplo:

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}

Enumeración de Estándares de Accesibilidad

La clase ConfigurationOverrides incluye una enumeración AccessibilityStandard que define los estándares de accesibilidad disponibles:

Valores de Enum

• WCAG2A - WCAG 2.0 Nivel A
• WCAG2AA - WCAG 2.0 Nivel AA
• WCAG2AAA - WCAG 2.0 Nivel AAA
• WCAG21A - WCAG 2.1 Nivel A
• WCAG21AA - WCAG 2.1 Nivel AA
• WCAG21AAA - WCAG 2.1 Nivel AAA
• WCAG22A - WCAG 2.2 Nivel A
• WCAG22AA - WCAG 2.2 Nivel AA
• WCAG22AAA - WCAG 2.2 Nivel AAA
• TTV5 - Evaluador de Confianza v5
• EN301549 - EN 301 549
• RGAAV4 - RGAA versión 4 (estándar de accesibilidad francés; requiere axe-core 4.11.0 o posterior)
• ALL - Todos los estándares

Ejemplo:

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. Configuraciones Mutuamente Excluyentes: No puedes usar ambos configurationOverrides.accessibilityStandard y runOptions.runOnly al mismo tiempo.

2. Propiedades Nulas: Todas las propiedades en ConfigurationOverrides por defecto son null. Cuando una propiedad es null, se utiliza la configuración global del centro de desarrollo de axe.

3. Precedencia: Las sobrescrituras de configuración tienen precedencia sobre las configuraciones globales en tu cuenta de axe, permitiéndote personalizar las pruebas para conjuntos de pruebas o ejecuciones específicas.

4. Serialización: El método toJson() incluye valores nulos en el resultado, haciendo que la estructura JSON sea consistente independientemente de qué propiedades estén configuradas.

Ver También

• Opciones de AxeWatcher
• AxeWatcher
• Opciones de AxeRun
• AxeRunOnly