Classe ConfigurationOverrides

La classe ConfigurationOverrides vous permet de remplacer les paramètres configuration axe globaux pour les tests d'accessibilité avec axe Watcher. Vous pouvez utiliser cette classe pour personnaliser les normes d'accessibilité, activer les meilleures pratiques et les règles expérimentales, et spécifier la version d'axe-core à utiliser lors des tests.

Ces remplacements prennent le pas sur les paramètres de configuration globaux définis dans votre Compte axe.

Constructeur

ConfigurationOverrides()

Crée une nouvelle instance de ConfigurationOverrides avec les paramètres par défaut (toutes les propriétés sont définies sur null).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Méthodes

setEnableBestPractices(boolean enableBestPractices)

Active ou désactive les règles de meilleures pratiques lors des tests d'accessibilité. Les règles de meilleures pratiques identifient les problèmes qui ne sont pas strictement requis par les normes d'accessibilité mais qui peuvent améliorer l'expérience utilisateur.

Paramètres :

• enableBestPractices - Valeur booléenne indiquant s'il faut activer les règles de meilleures pratiques

Renvoie :

• ConfigurationOverrides - L'instance actuelle pour l'enchaînement des méthodes

Exemple :

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

setEnableExperimental(boolean enableExperimental)

Active ou désactive les règles expérimentales lors des tests d'accessibilité. Les règles expérimentales sont des règles nouvelles ou instables qui sont encore en développement.

Paramètres :

• enableExperimental - Valeur booléenne indiquant s'il faut activer les règles expérimentales

Renvoie :

• ConfigurationOverrides - L'instance actuelle pour l'enchaînement des méthodes

Exemple :

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

setAccessibilityStandard(AccessibilityStandard standard)

Définit la norme d'accessibilité à utiliser pour les tests. Cela détermine quel ensemble de règles d'accessibilité est appliqué pendant les tests.

Paramètres :

• standard - Une valeur d'énumération AccessibilityStandard qui spécifie la norme à utiliser

Renvoie :

• ConfigurationOverrides - L'instance actuelle pour l'enchaînement des méthodes

Exemple :

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

setAxeCoreVersion(String axeCoreVersion)

Définit la version d'axe-core à utiliser pour les tests. Cela vous permet de spécifier une version particulière ou d'utiliser la dernière version.

Paramètres :

• axeCoreVersion - La chaîne de version d'axe-core à utiliser (par exemple, "4.6.0" ou "latest")

Renvoie :

• ConfigurationOverrides - L'instance actuelle pour l'enchaînement des méthodes

Exemple :

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

getEnableBestPractices()

Obtient le paramètre actuel pour l'activation des règles de meilleures pratiques.

Renvoie :

• Boolean - Le paramètre actuel pour l'activation des règles de meilleures pratiques

Exemple :

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

getEnableExperimental()

Obtient le paramètre actuel pour l'activation des règles expérimentales.

Renvoie :

• Boolean - Le paramètre actuel pour l'activation des règles expérimentales

Exemple :

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

getAccessibilityStandard()

Obtient le paramètre actuel de la norme d'accessibilité.

Renvoie :

• String - Le paramètre actuel de la norme d'accessibilité

Exemple :

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

getAxeCoreVersion()

Obtient le paramètre actuel de la version d'axe-core.

Renvoie :

• String - Le paramètre actuel de la version d'axe-core

Exemple :

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

toJson()

Sérialise l'instance ConfigurationOverrides en une chaîne JSON.

Renvoie :

• String - Une représentation en chaîne JSON des paramètres de configuration remplaçables

Exemple :

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}

Enumération des normes d'accessibilité

La classe ConfigurationOverrides comprend une énumération AccessibilityStandard qui définit les normes d'accessibilité disponibles :

Valeurs de l'énumération

• WCAG2A - WCAG 2.0 Niveau A
• WCAG2AA - WCAG 2.0 Niveau AA
• WCAG2AAA - WCAG 2.0 Niveau AAA
• WCAG21A - WCAG 2.1 Niveau A
• WCAG21AA - WCAG 2.1 Niveau AA
• WCAG21AAA - WCAG 2.1 Niveau AAA
• WCAG22A - WCAG 2.2 Niveau A
• WCAG22AA - WCAG 2.2 Niveau AA
• WCAG22AAA - WCAG 2.2 Niveau AAA
• TTV5 - Trusted Tester v5
• EN301549 - EN 301 549
• RGAAV4 - RGAA version 4 (norme d'accessibilité française ; nécessite axe-core 4.11.0 ou ultérieur)
• ALL - Toutes les normes

Exemple :

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);

Notes Importantes

1. Paramètres Mutuellement Exclusifs : Vous ne pouvez pas utiliser à la fois configurationOverrides.accessibilityStandard et runOptions.runOnly simultanément.

2. Propriétés Nulle : Toutes les propriétés dans ConfigurationOverrides ont pour valeur par défaut null. Lorsqu'une propriété est null, la configuration globale du axe Developer Hub est utilisée à la place.

3. Précédence : Les paramètres de configuration remplaçables prennent le pas sur les paramètres globaux de votre compte axe, vous permettant de personnaliser les tests pour des suites de tests ou des exécutions spécifiques.

4. Sérialisation : La méthode toJson() inclut les valeurs nulles dans la sortie, rendant la structure JSON cohérente indépendamment des propriétés définies.

Voir Aussi

• AxeWatcherOptions
• AxeWatcher
• AxeRunOptions
• AxeRunOnly