ConfigurationOverrides Klasse

De ConfigurationOverrides klasse stelt u in staat om axe-configuratie globale instellingen voor toegankelijkheidstests met axe Watcher te overschrijven. U kunt deze klasse gebruiken om toegankelijkheidsnormen aan te passen, beste praktijken en experimentele regels in te schakelen en de axe-core-versie te specificeren die tijdens het testen moet worden gebruikt.

Deze overschrijvingen krijgen voorrang boven de globale configuratie-instellingen die zijn gedefinieerd in uw axe-account.

Constructor

ConfigurationOverrides()

Maakt een nieuwe instantie van ConfigurationOverrides met standaardinstellingen (alle eigenschappen ingesteld op null).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Methoden

setEnableBestPractices(boolean enableBestPractices)

Schakelt regels voor beste praktijken in of uit tijdens toegankelijkheidstests. Regels voor beste praktijken identificeren problemen die niet strikt vereist zijn door toegankelijkheidsnormen, maar die de gebruikerservaring kunnen verbeteren.

Parameters:

• enableBestPractices - Booleaanse waarde die aangeeft of regels voor beste praktijken moeten worden ingeschakeld

Retourneert:

• ConfigurationOverrides - De huidige instantie voor method chaining

Voorbeeld:

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

setEnableExperimental(boolean enableExperimental)

Schakelt experimentele regels in of uit tijdens toegankelijkheidstests. Experimentele regels zijn nieuwe of onstabiele regels die nog in ontwikkeling zijn.

Parameters:

• enableExperimental - Booleaanse waarde die aangeeft of experimentele regels moeten worden ingeschakeld

Retourneert:

• ConfigurationOverrides - De huidige instantie voor method chaining

Voorbeeld:

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

setAccessibilityStandard(AccessibilityStandard standard)

Stelt de toegankelijkheidsstandaard in voor testen. Dit bepaalt welke set van toegankelijkheidsregels worden toegepast tijdens het testen.

Parameters:

• standard - Een AccessibilityStandard enumwaarde die de standaard specificeert om te gebruiken

Retourneert:

• ConfigurationOverrides - De huidige instantie voor method chaining

Voorbeeld:

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

setAxeCoreVersion(String axeCoreVersion)

Stelt de versie van axe-core in die gebruikt moet worden voor testen. Hiermee kunt u een specifieke versie opgeven of de nieuwste versie gebruiken.

Parameters:

• axeCoreVersion - De versie string van axe-core die moet worden gebruikt (bijv. „4.6.0“ of „latest“)

Retourneert:

• ConfigurationOverrides - De huidige instantie voor method chaining

Voorbeeld:

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

getEnableBestPractices()

Haalt de huidige instelling op voor het inschakelen van regels voor beste praktijken.

Retourneert:

• Boolean - De huidige instelling voor het inschakelen van regels voor beste praktijken

Voorbeeld:

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

getEnableExperimental()

Haalt de huidige instelling op voor het inschakelen van experimentele regels.

Retourneert:

• Boolean - De huidige instelling voor het inschakelen van experimentele regels

Voorbeeld:

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

getAccessibilityStandard()

Haalt de huidige instelling van de toegankelijkheidsnorm op.

Retourneert:

• String - De huidige instelling van de toegankelijkheidsnorm

Voorbeeld:

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

getAxeCoreVersion()

Haalt de huidige axe-core versie-instelling op.

Retourneert:

• String - De huidige axe-core versie-instelling

Voorbeeld:

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

toJson()

Serialiseert de ConfigurationOverrides instantie naar een JSON-string.

Retourneert:

• String - Een JSON-stringrepresentatie van de configuratie-overschrijvingen

Voorbeeld:

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}

AccessibilityStandard Enum

De ConfigurationOverrides klasse bevat een AccessibilityStandard enum die de beschikbare toegankelijkheidsnormen definieert:

Enum-waarden

• 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
• ALL - Alle normen

Voorbeeld:

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

Belangrijke Opmerkingen

1. Wederzijds Exclusieve Instellingen: U kunt niet zowel configurationOverrides.accessibilityStandard als runOptions.runOnly tegelijkertijd gebruiken.

2. Null Eigenschappen: Alle eigenschappen in ConfigurationOverrides zijn standaard null. Wanneer een eigenschap nullis, wordt de globale configuratie van axe Developer Hub in plaats daarvan gebruikt.

3. Voorrang: Configuratie-overschrijvingen hebben voorrang op globale instellingen in uw axe-account, waardoor u testen kunt aanpassen voor specifieke testsuites of -uitvoeringen.

4. Serialisatie: De toJson() methode omvat null-waarden in de uitvoer, waardoor de JSON-structuur consistent blijft, ongeacht welke eigenschappen zijn ingesteld.

Zie Ook

• AxeWatcherOptions
• AxeWatcher
• AxeRunOpties
• AxeRunAlleen