ConfigurationOverrides-klasse

De ConfigurationOverrides-klasse stelt je in staat om axe-configuratie globale instellingen voor toegankelijkheidstests met Axe Watcher te overschrijven. Je kunt deze klasse gebruiken om toegankelijkheidsnormen aan te passen, beste praktijken en experimentele regels in te schakelen, en de te gebruiken axe-core versie tijdens tests te specificeren.

Deze overschrijvingen hebben voorrang op de globale configuratie-instellingen die zijn gedefinieerd in je Axe-account.

Constructor

ConfigurationOverrides()

Creëert een nieuwe instantie van ConfigurationOverrides met standaardinstellingen (alle eigenschappen ingesteld op null).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Methoden

setEnableBestPractices(boolean enableBestPractices)

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

Parameters:

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

Geeft terug:

• 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

Geeft terug:

• 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 testen.

Parameters:

• standard - Een AccessibilityStandard enumwaarde die de standaard aangeeft voor gebruik

Geeft terug:

• 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 voor testen. Hiermee kun je een specifieke versie specificeren of de nieuwste versie gebruiken.

Parameters:

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

Geeft terug:

• ConfigurationOverrides - De huidige instantie voor method chaining

Voorbeeld:

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

getEnableBestPractices()

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

Geeft terug:

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

Voorbeeld:

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

getEnableExperimental()

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

Geeft terug:

• 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 voor de toegankelijkheidsstandaard op.

Geeft terug:

• String - De huidige instelling voor de toegankelijkheidsstandaard

Voorbeeld:

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

getAxeCoreVersion()

Haalt de huidige instelling van de axe-core-versie op.

Geeft terug:

• String - De huidige instelling van de axe-core-versie

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.

Geeft terug:

• 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 toegankelijkheidsstandaarden 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
• RGAAV4 - RGAA versie 4 (Franse toegankelijkheidsnorm; vereist axe-core 4.11.0 of later)
• ALL - Alle standaarden

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 Notities

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

2. Null Eigenschappen: Alle eigenschappen in ConfigurationOverrides staan standaard op null. Wanneer een eigenschap is null, wordt de globale configuratie van Axe Developer Hub in plaats daarvan gebruikt.

3. Voorrang: Configuratie-overschrijvingen hebben voorrang op globale instellingen in je Axe-account, waardoor je tests kunt aanpassen voor specifieke testsuites of runs.

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

Zie Ook

• AxeWatcherOpties
• AxeWatcher
• AxeRunOpties
• AxeRunOnly