ConfigurationOverrides-Klasse

Die ConfigurationOverrides-Klasse ermöglicht es Ihnen, axe-Konfiguration globale Einstellungen für das barrierefreie Testen mit dem axe Watcher zu überschreiben. Sie können diese Klasse verwenden, um Barrierefreiheitsstandards anzupassen, Best-Practice- und experimentelle Regeln zu aktivieren und die zu verwendende axe-core-Version während der Tests festzulegen.

Diese Überschreibungen haben Vorrang vor den globalen Konfigurationseinstellungen, die in Ihrer axe-Konto definiert sind.

Konstruktor

ConfigurationOverrides()

Erstellt eine neue Instanz von ConfigurationOverrides mit den Standardeinstellungen (alle Eigenschaften auf null gesetzt).

ConfigurationOverrides configOverrides = new ConfigurationOverrides();

Methoden

setEnableBestPractices(boolean enableBestPractices)

Aktiviert oder deaktiviert Best-Practice-Regeln während des barrierefreien Testens. Best-Practice-Regeln identifizieren Probleme, die nicht strikt durch Barrierefreiheitsstandards vorgeschrieben sind, aber die Benutzererfahrung verbessern können.

Parameter:

• enableBestPractices - Boolescher Wert, der angibt, ob Best-Practice-Regeln aktiviert werden sollen

Rückgabewert:

• ConfigurationOverrides - Die aktuelle Instanz zum Verketteln von Methodenaufrufen

Beispiel:

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

setEnableExperimental(boolean enableExperimental)

Aktiviert oder deaktiviert experimentelle Regeln während des barrierefreien Testens. Experimentelle Regeln sind neue oder instabile Regeln, die sich noch in der Entwicklung befinden.

Parameter:

• enableExperimental - Boolescher Wert, der angibt, ob experimentelle Regeln aktiviert werden sollen

Rückgabewert:

• ConfigurationOverrides - Die aktuelle Instanz zum Verketteln von Methodenaufrufen

Beispiel:

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

setAccessibilityStandard(AccessibilityStandard standard)

Legt den Barrierefreiheitsstandard fest, der für die Tests verwendet werden soll. Dies bestimmt, welche Barrierefreiheitsregeln während der Tests angewendet werden.

Parameter:

• standard - Ein AccessibilityStandard-Enum-Wert, der den zu verwendenden Standard angibt

Rückgabewert:

• ConfigurationOverrides - Die aktuelle Instanz zum Verketteln von Methodenaufrufen

Beispiel:

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

setAxeCoreVersion(String axeCoreVersion)

Legt die Version von axe-core fest, die für die Tests verwendet werden soll. Dies ermöglicht es Ihnen, eine spezifische Version oder die neueste Version zu verwenden.

Parameter:

• axeCoreVersion - Der Versionsstring von axe-core, der verwendet werden soll (z. B. „4.6.0“ oder „latest“)

Rückgabewert:

• ConfigurationOverrides - Die aktuelle Instanz zum Verketteln von Methodenaufrufen

Beispiel:

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

getEnableBestPractices()

Erhält die aktuelle Einstellung zur Aktivierung von Best-Practice-Regeln.

Rückgabewert:

• Boolean - Die aktuelle Einstellung zur Aktivierung von Best-Practice-Regeln

Beispiel:

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

getEnableExperimental()

Erhält die aktuelle Einstellung zur Aktivierung von experimentellen Regeln.

Rückgabewert:

• Boolean - Die aktuelle Einstellung zur Aktivierung von experimentellen Regeln

Beispiel:

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

getAccessibilityStandard()

Erhält die derzeitige Einstellung des Barrierefreiheitsstandards.

Rückgabewert:

• String - Die derzeitige Einstellung des Barrierefreiheitsstandards

Beispiel:

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

getAxeCoreVersion()

Erhält die aktuelle Versionseinstellung von axe-core.

Rückgabewert:

• String - Die aktuelle Versionseinstellung von axe-core

Beispiel:

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

toJson()

Serialisiert die ConfigurationOverrides-Instanz zu einem JSON-String.

Rückgabe:

• String – Eine JSON-String-Darstellung der Konfigurationsüberschreibungen

Beispiel:

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

Die ConfigurationOverrides-Klasse enthält ein AccessibilityStandard-Enum, das die verfügbaren Barrierefreiheitsstandards definiert:

Enum-Werte

• WCAG2A – WCAG 2.0 Level A
• WCAG2AA – WCAG 2.0 Level AA
• WCAG2AAA – WCAG 2.0 Level AAA
• WCAG21A – WCAG 2.1 Level A
• WCAG21AA – WCAG 2.1 Level AA
• WCAG21AAA – WCAG 2.1 Level AAA
• WCAG22A – WCAG 2.2 Level A
• WCAG22AA – WCAG 2.2 Level AA
• WCAG22AAA – WCAG 2.2 Level AAA
• TTV5 – Trusted Tester v5
• EN301549 – EN 301 549
• RGAAV4 – RGAA Version 4 (französischer Barrierefreiheitsstandard; erfordert axe-core 4.11.0 oder später)
• ALL – Alle Standards

Beispiel:

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

Wichtige Hinweise

1. Mutual ausschließende Einstellungen: Sie können nicht sowohl configurationOverrides.accessibilityStandard als auch runOptions.runOnly gleichzeitig verwenden.

2. Null-Eigenschaften: Alle Eigenschaften in ConfigurationOverrides haben standardmäßig null. Wenn eine Eigenschaft null ist, wird stattdessen die globale Konfiguration aus dem axe Developer Hub verwendet.

3. Vorrang: Konfigurationsüberschreibungen haben Vorrang vor globalen Einstellungen in Ihrem axe-Konto, sodass Sie Tests für spezifische Test-Suites oder -Durchläufe anpassen können.

4. Serialisierung: Die toJson()-Methode enthält Nullwerte in der Ausgabe, sodass die JSON-Struktur konsistent bleibt, unabhängig davon, welche Eigenschaften gesetzt sind.

Siehe auch

• AxeWatcherOptions
• AxeWatcher
• AxeRunOptions
• AxeRunOnly