API-Referenz für Java Playwright

Dieses Dokument bietet eine API-Referenz für die AxePlaywrightBuilder Java-Klasse, die von der Playwright Java-Integration bereitgestellt wird.

Konstruktoren

AxePlaywrightBuilder(Page)

Initialisiert eine neue Instanz der AxePlaywrightBuilder-Klasse für das angegebene Page-Objekt.

public AxePlaywrightBuilder(Page page);

Parameter

Beispiel

Das folgende Codebeispiel demonstriert diesen Konstruktor. Es zeigt auch, wie ein Page-Objekt und ein AxePlaywrightBuilder-Objekt mit diesem Page-Objekt erstellt werden.

// Example Page
Page page = browser.newPage();

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Initialisiert eine neue Instanz der AxePlaywrightBuilder-Klasse mit dem angegebenen Page-Objekt und dem angegebenen File-Objekt. Der File enthält benutzerdefinierte Regeln in einer JSON-Datei.

public AxePlaywrightBuilder(Page page, File rules);

Parameter

Beispiel

Das folgende Beispiel zeigt, wie dieser Konstruktor verwendet wird.

// Example Page
Page page = browser.newPage();

File customRuleset = new File("somePath/custom-ruleset.json")
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

AxePlaywrightBuilder(Page, String)

Initialisiert eine neue Instanz der AxePlaywrightBuilder-Klasse mit dem angegebenen Page-Objekt und dem angegebenen String-Objekt, das benutzerdefinierte Regeln in einem JSON-String enthält.

public AxePlaywrightBuilder(Page page, String rules);

Parameter

Beispiel

Das folgende Codebeispiel veranschaulicht diesen Konstruktor.

// Example Page
Page page = browser.newPage();

String customRuleset = "{...}"
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

Methoden

analysieren

Analysieren Sie die Playwright-Seite (angegeben, als das AxePlaywrightBuilder-Objekt erstellt wurde) und geben Sie ein AxeResults-Objekt aus der abgeschlossenen Analyse zurück.

AxeResults AxePlaywrightBuilder.analyze();

Rückgabewert

• AxeResults

Beispiel

Das folgende Codebeispiel zeigt, wie die Methode 'analysieren' verwendet wird.

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxeResults axeResults = axePlaywrightBuilder.analyze();

/* Usage may include:
axeResults.getViolations() - returns only violation results
axeResults.getPasses() - returns only pass results
axeResults.getIncomplete() - returns only incomplete results
*/

konfigurieren(Datei)

Stellen Sie eine benutzerdefinierte Konfiguration über eine JSON-Datei zur Verfügung.

public AxePlaywrightBuilder configure(File axeConfigure);

Weitere Informationen zum Format der Konfigurationsdatei finden Sie unter axe-core Konfiguration.

Parameter

Beispiel

Das folgende Beispiel zeigt, wie eine Konfiguration aufgerufen und mit einem AxePlaywrightBuilder-Objekt verwendet wird.

File myAxeConfigure = new File("./axe-configure.json");

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

konfigurieren(String)

Stellen Sie eine benutzerdefinierte Konfiguration für axe-core bereit (die zugrunde liegende Technologie zur Analyse der Zugänglichkeit), die über einen JSON-String ausgeführt wird.

public AxePlaywrightBuilder configure(String axeConfigure);

Weitere Informationen zum Format der Konfigurationsdatei finden Sie unter axe-core Konfiguration.

Parameter

Beispiel

Das folgende Beispiel zeigt, wie eine Konfiguration aufgerufen und mit einem AxePlaywrightBuilder-Objekt verwendet wird.

String myAxeConfigure = "{..}"

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

Regeln deaktivieren

Deaktivieren Sie Regeln, um deren Ausführung während der Analyse zu verhindern.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiel

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsüberprüfung für eine einzelne Regel mithilfe der singletonList-Methode der Collections-Klasse und für mehrere Regeln mit einer List deaktiviert.

// Single Rule
AxePlaywrightBuilder axePlaywrightBuilder1 = new AxePlaywrightBuilder(page)
        .disableRules(Collections.singletonList("color-contrast"));

// Multiple Rules
AxePlaywrightBuilder axePlaywrightBuilder2 = new AxePlaywrightBuilder(page)
        .disableRules(Arrays.asList("color-contrast", "image-alt"));

exclude(String)

Geben Sie einen einzelnen CSS-Selektor an, um HTML-Elemente während der Analyse auszuschließen. Um mehrere nicht zusammenhängende Teile der Seite zu überspringen, rufen Sie exclude jeweils einmal für jeden Teil auf und übergeben dabei jedes Mal einen einzelnen Selektor.

public AxePlaywrightBuilder exclude(String selector);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man Elemente mit diesen Attributen von der Analyse ausschließt:

• class="some-class"
• class="some-other-class"

new AxePlaywrightBuilder(page)
        .exclude(".some-class")
        .exclude(".some-other-class");

exclude(List<String>)

Geben Sie einen CSS-iframe-Selektor an, um HTML-Elemente während der Analyse auszuschließen.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man Elemente mit CSS-iframe-Selektoren ausschließt.

// To exclude everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .exclude(Arrays.asList("#parent-iframe", "#html"))

Da es keine exclude(String...) Überladung gibt, führt das Übergeben von mehr als einem String an exclude ebenfalls zu einem einzigen iframe-Selektor statt zu separaten Ausschlüssen. Der folgende Aufruf löst sich in exclude(Object...) auf und bedeutet dasselbe wie das obige Beispiel.

new AxePlaywrightBuilder(page)
        .exclude("#parent-iframe", "#html")

exclude(FromFrames) drückt dasselbe expliziter aus und ist die empfohlene Form für neue Tests.

exclude(FromFrames)

Schließen Sie ein Element innerhalb von einem oder mehreren verschachtelten iframes aus, indem Sie einen expliziten FromFrames Selektor verwenden.

public AxePlaywrightBuilder exclude(FromFrames fromFrames);

Importieren Sie die Klasse mit import com.deque.html.axecore.args.FromFrames;.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel überspringt das Formular innerhalb des #payment-frame iframes.

new AxePlaywrightBuilder(page)
        .exclude(new FromFrames("#payment-frame", "form"))

exclude(FromShadowDom)

Schließen Sie ein Element innerhalb von einem oder mehreren verschachtelten Shadow-DOM-Bäumen aus, indem Sie einen expliziten FromShadowDom Selektor verwenden.

public AxePlaywrightBuilder exclude(FromShadowDom fromShadowDom);

Importieren Sie die Klasse mit import com.deque.html.axecore.args.FromShadowDom;.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel überspringt das #search Formular innerhalb der Shadow-Root, die an .app-header angefügt ist.

new AxePlaywrightBuilder(page)
        .exclude(new FromShadowDom(".app-header", "form#search"))

exclude(Object)

Schließen Sie einen Selektor aus, der als einzelnes Objekt bereitgestellt wird. Diese Überladung wird nur ausgewählt, wenn der statische Typ des Arguments keiner der oben genannten Typen ist, wie zum Beispiel eine Variable, die als Object deklariert ist. Bevorzugen Sie die typisierten Überladungen.

public AxePlaywrightBuilder exclude(Object selector);

Parameter

Rückgabewert

• AxePlaywrightBuilder

exclude(Object...)

Schließen Sie einen Selektor aus, der einfache CSS-Selektoren mit FromFrames- oder FromShadowDom-Selektoren mischt, für Fälle, die die anderen Overloads nicht abbilden können.

public AxePlaywrightBuilder exclude(Object... selector);

Dieser Overload wird ausgewählt, wenn der Aufruf mehr als ein Argument übergibt. Wird ein einzelner FromFrames- oder FromShadowDom-Selektor übergeben, werden stattdessen exclude(FromFrames) oder exclude(FromShadowDom) gewählt.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Im folgenden Beispiel wird .target innerhalb des an #host angehängten Shadow-Root übersprungen, innerhalb des #frame-iframes.

new AxePlaywrightBuilder(page)
        .exclude("#frame", new FromShadowDom("#host", ".target"))

include(String)

Geben Sie einen einzelnen CSS-Selektor an, der während der Analyse einbezogen wird. Um mehrere nicht zusammenhängende Teile der Seite zu testen, rufen Sie include einmal für jeden auf und übergeben Sie dabei jedes Mal einen einzelnen Selektor.

public AxePlaywrightBuilder include(String selector);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man zwei verschiedene Klassen in die Analyse einbezieht. Beachten Sie, wie das Beispiel Methodenverkettung verwendet, um mehr als eine CSS-Klasse zu spezifizieren.

new AxePlaywrightBuilder(page)
        .include(".some-class")
        .include(".some-other-class");

include(List<String>)

Geben Sie einen CSS-iframe-Selektor an, der während der Analyse einbezogen wird.

public AxePlaywrightBuilder include(List<String> includeCSS);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man Elemente mit CSS-iframe-Selektoren einbezieht.

// To include everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .include(Arrays.asList("#parent-iframe", "#html"))

Da es keinen include(String...)-Overload gibt, führt das Übergeben von mehr als einem String an include ebenfalls zu einem einzigen iframe-Selektor, anstatt zu separaten Includierungen. Der folgende Aufruf wird zu include(Object...) aufgelöst und bedeutet dasselbe wie das obige Beispiel.

new AxePlaywrightBuilder(page)
        .include("#parent-iframe", "#html")

include(FromFrames) drückt dasselbe klarer aus und ist die empfohlene Form für neue Tests.

include(FromFrames)

Schließen Sie ein Element innerhalb eines oder mehrerer verschachtelter iframes ein, indem Sie einen expliziten FromFrames-Selektor verwenden.

public AxePlaywrightBuilder include(FromFrames fromFrames);

Importieren Sie die Klasse mit import com.deque.html.axecore.args.FromFrames;.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Im folgenden Beispiel wird das Formular innerhalb des #payment-frame-iframes getestet.

new AxePlaywrightBuilder(page)
        .include(new FromFrames("#payment-frame", "form"))

include(FromShadowDom)

Schließen Sie ein Element innerhalb eines oder mehrerer verschachtelter Shadow-DOM-Strukturen ein, indem Sie einen expliziten FromShadowDom-Selektor verwenden.

public AxePlaywrightBuilder include(FromShadowDom fromShadowDom);

Importieren Sie die Klasse mit import com.deque.html.axecore.args.FromShadowDom;.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Im folgenden Beispiel wird das #search-Formular innerhalb des an .app-header angehängten Shadow-Root getestet.

new AxePlaywrightBuilder(page)
        .include(new FromShadowDom(".app-header", "form#search"))

include(Object)

Schließen Sie einen als Einzelobjekt bereitgestellten Selektor ein. Dieser Overload wird nur gewählt, wenn der statische Typ des Arguments keiner der obigen Typen ist, wie zum Beispiel eine als Object deklarierte Variable. Bevorzugen Sie die typisierten Overloads.

public AxePlaywrightBuilder include(Object selector);

Parameter

Rückgabewert

• AxePlaywrightBuilder

include(Object...)

Schließen Sie einen Selektor ein, der einfache CSS-Selektoren mit FromFrames- oder FromShadowDom-Selektoren mischt, für Fälle, die die anderen Overloads nicht abbilden können.

public AxePlaywrightBuilder include(Object... selector);

Dieser Overload wird ausgewählt, wenn der Aufruf mehr als ein Argument übergibt. Wird ein einzelner FromFrames- oder FromShadowDom-Selektor übergeben, werden stattdessen include(FromFrames) oder include(FromShadowDom) gewählt.

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Im folgenden Beispiel wird .target innerhalb des an #host angehängten Shadow-Root getestet, innerhalb des #frame-iframes.

new AxePlaywrightBuilder(page)
        .include("#frame", new FromShadowDom("#host", ".target"))

setLegacyMode

Schließt Barrierefreiheitsprobleme aus, die in cross-domain frames und iframes auftreten können.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel schaltet den Legacy-Modus ein.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

Stellen Sie eine benutzerdefinierte Version von axe-core mit dem Java File-Objekt bereit

public AxePlaywrightBuilder withAxeSource(File file);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man eine andere Datei für axe-core anstelle der bereitgestellten Version verwendet. Dies wäre nur in speziellen Fällen notwendig.

File axeLegacySource = new File("somepath/axe-core@legacy.js");

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

Stellen Sie eine benutzerdefinierte Version von axe-core bereit, indem Sie eine bereits geparste Quelle nutzen.

public AxePlaywrightBuilder withAxeSource(String src);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man eine Datei in eine String einliest und diese als Quelldatei mit withAxeSource verwendet.

String source = IOUtils.toString(somepPath.toURI(), StandardCharsets.UTF_8);

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

withOnlyBestPracticeRules

Überprüfen Sie auf Barrierefreiheitsprobleme mit nur dem Best-Practice-Regelsatz aktiviert.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsanalyse mit nur den Best-Practice-Regeln aktiviert.

new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

withOnlyExperimentalRules

Überprüfen Sie auf Barrierefreiheitsprobleme mit nur dem experimentellen Regelsatz aktiviert.

public AxePlaywrightBuilder withOnlyExperimentalRules();

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt, wie man die Barrierefreiheitsanalyse mit nur den experimentellen Regeln aktiviert.

new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

withRules

Beschränken Sie die während der Barrierefreiheitsanalyse auszuführenden Regeln auf die angegebenen.

public AxePlaywrightBuilder exclude(List<String> rules);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Das folgende Beispiel zeigt zwei verschiedene Möglichkeiten der Verwendung der withRules-Methode. Die erste erstellt eine List mit einer Regel, Farbkontrast. Die zweite erstellt eine List, die die Regeln Farbkontrast und Bildbeschreibung enthält.

// Single Rule
new AxePlaywrightBuilder(page)
        .withRules(Collections.singletonList("color-contrast"));

// Multiple Rules
new AxePlaywrightBuilder(page)
        .withRules(Arrays.asList("color-contrast", "image-alt"));

mitTags

Begrenzt die Barrierefreiheitsanalyse auf den Regel- oder Regelsatz, der zu den angegebenen Tags gehört.

public AxePlaywrightBuilder withTags(List<String> tags);

Parameter

Rückgabewert

• AxePlaywrightBuilder

Beispiele

Dieses Beispiel zeigt, wie die Barrierefreiheitsanalyse auf Regeln begrenzt wird, die zu den angegebenen Tags gehören. Das erste Code-Beispiel zeigt, wie die Analyse auf Regeln beschränkt wird, die Teil der wcag21aa-Spezifikation sind. Das zweite Beispiel zeigt, wie die Analyse auf die wcag21aa-Spezifikation und die best-practice-Regeln beschränkt wird.

// Single tag
new AxePlaywrightBuilder(page)
        .withTags(Collections.singletonList("wcag21aa"));

// Multiple tags
 new AxePlaywrightBuilder(page)
        .withTags(Arrays.asList("wcag21aa", "best-practice"));