API-referentie voor Java Playwright

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

API-referentie voor de AxePlaywrightBuilder-klasse in de Axe DevTools voor Web Java Playwright-integratie

Not for use with personal data

Dit document biedt een API-referentie voor de AxePlaywrightBuilder Java-klasse, die wordt geleverd door de Playwright Java-integratie.

note

De meeste methoden in de AxePlaywrightBuilder-klasse retourneren een AxePlaywrightBuilder-object, waarmee je eenvoudig meerdere methoden aan elkaar kunt koppelen. Zie de onderstaande codevoorbeelden voor voorbeelden van het koppelen van methoden.

Constructors

Constructor Beschrijving
AxePlaywrightBuilder(Page) Standaardconstructor die een AxePlaywrightBuilder-object creëert.
AxePlaywrightBuilder(Page, File) Creëer een AxePlaywrightBuilder-object en specificeer een JSON-bestand met aangepaste regels die tijdens de analyse moeten worden gebruikt.
AxePlaywrightBuilder(Page, String) Creëer een AxePlaywrightBuilder-object terwijl je een JSON-String specificeert die aangepaste regels bevat.

AxePlaywrightBuilder(Page)

Initialiseert een nieuwe instantie van de AxePlaywrightBuilder-klasse voor het gespecificeerde Page-object.

public AxePlaywrightBuilder(Page page);

Parameters

Naam Type Beschrijving
page com.microsoft.Playwright.Page Het Page-object dat gebruikt moet worden voor toegankelijkheidsanalyse.

Voorbeeld

Het volgende codevoorbeeld demonstreert deze constructor. Het laat ook zien hoe je een Page-object en een AxePlaywrightBuilder-object met dat Page-object kunt maken.

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

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Initialiseert een nieuwe instantie van de AxePlaywrightBuilder-klasse met het gespecificeerde Page object en het gespecificeerde File object. De File bevat aangepaste regels in een JSON-bestand.

public AxePlaywrightBuilder(Page page, File rules);

Parameters

Naam Type Beschrijving
page com.microsoft.Playwright.Page Het vereiste Page-object.
regels File Een File-object dat een JSON-bestand met aangepaste toegankelijkheidsregels vertegenwoordigt.

Voorbeeld

Het volgende voorbeeld laat zien hoe je deze constructor gebruikt.

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

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

AxePlaywrightBuilder(Page, String)

Initialiseert een nieuwe instantie van de AxePlaywrightBuilder klasse met het opgegeven Pagina object en het opgegeven String object, dat aangepaste regels bevat in een JSON-string.

public AxePlaywrightBuilder(Page page, String rules);

Parameters

Naam Type Beschrijving
pagina com.microsoft.Playwright.Pagina Het vereiste Pagina object
regels String Een JSON-string die een set aangepaste toegankelijkheidsregels vertegenwoordigt.

Voorbeeld

Het volgende codevoorbeeld demonstreert deze constructor.

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

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

Methoden

Methode Beschrijving
analyseren Analyseer de Playwright-pagina en retourneer een AxeResultaten object van de voltooide analyse.
configureer(Bestand) Bied een aangepaste configuratie over hoe axe-core wordt uitgevoerd via een JSON-bestand.
configureer(String) Bied een aangepaste configuratie over hoe axe-core wordt uitgevoerd via een JSON-string.
schakelRegelsUit Voorkomt dat de gespecificeerde regels worden uitgevoerd tijdens de analyse.
uitsluiten Specificeert CSS-selectors om bepaalde HTML-inhoud uit te sluiten tijdens de analyse.
inclusief Specificeert CSS-selectors die HTML-inhoud tijdens de analyse insluiten.
stelLegacyModeIn Stel de legacy-modus in om toegankelijkheidsproblemen uit te sluiten die kunnen optreden in cross-domain frames en iframes.
metAxeSource(Bestand) Bied een aangepaste versie van axe-core met gebruik van een Bestand object.
metAxeSource(String) Bied een aangepaste versie van axe-core door gebruik te maken van een String object.
metAlleenBestPracticeRegels Controleert toegankelijkheid met alleen de best-practice regels.
metAlleenExperimenteleRegels Controleert toegankelijkheid met alleen de experimentele regels.
metRegels Beperk de toegankelijkheidsregels tot de gespecificeerde regels.
metTags Beperk de gecontroleerde toegankelijkheidsregels tot de opgegeven lijst met tags.

analyseren

Analyseer de Playwright-pagina (gespecificeerd bij het aanmaken van het AxePlaywrightBuilder object) en retourneer een AxeResultaten object van de voltooide analyse.

AxeResults AxePlaywrightBuilder.analyze();

Retourneert

  • AxeResultaten

Voorbeeld

Het volgende codevoorbeeld demonstreert hoe de analyse-methode te gebruiken.


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
*/

configureer(Bestand)

Bied een aangepaste configuratie aan axe-core via een JSON-bestand.

public AxePlaywrightBuilder configure(File axeConfigure);

Voor meer informatie over het formaat van het configuratiebestand, zie axe-core configuratie.

Parameters

Naam Type Beschrijving
bestand Bestand Een Bestand object dat een axe-core configuratie in JSON vertegenwoordigt.

Voorbeeld

Het volgende voorbeeld toont hoe toegang te krijgen tot een configuratie en deze te gebruiken met een AxePlaywrightBuilder object.

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

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

configureer(Tekenreeks)

Bied een aangepaste configuratie aan axe-core (de onderliggende technologie voor het analyseren van toegankelijkheid) aan via een JSON-tekenreeks.

public AxePlaywrightBuilder configure(String axeConfigure);

Voor meer informatie over het formaat van het configuratiebestand, zie axe-core configuratie.

Parameters

Naam Type Beschrijving
axeConfig Tekenreeks Een Tekenreeks object dat een axe-core configuratie in JSON vertegenwoordigt.

Voorbeeld

Het volgende voorbeeld toont hoe toegang te krijgen tot een configuratie en deze te gebruiken met een AxePlaywrightBuilder object.

String myAxeConfigure = "{..}"

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

uitschakelRegels

Schakel regels uit die tijdens de analyse worden uitgevoerd.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parameters

Naam Type Beschrijving
regels Lijst<Tekenreeks> Een lijst van tekenreeksen die regels vertegenwoordigen om uit te schakelen tijdens de analyse.

Retourneert

  • AxePlaywrightBuilder

Voorbeeld

Het volgende voorbeeld laat zien hoe je toegankelijkheidscontrole voor een enkele regel kunt uitschakelen met de singletonList-methode van de Collections-klasse en meerdere regels kunt uitschakelen met een List.

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

uitsluiten

Geef CSS-selectoren op om HTML-elementen uit te sluiten tijdens de analyse.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parameters

Naam Type Beschrijving
excludeCSS List<String> Een lijst met CSS-selectoren die elementen specificeert die niet in een toegankelijkheidsanalyse worden opgenomen.

Keert terug

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld laat zien hoe je elementen kunt uitsluiten van de analyse met de volgende attributen:

  • class="some-class"
  • class="some-other-class"
new AxePlaywrightBuilder(page)
        .exclude(Collections.singletonList(".some-class"))
        .exclude(Collections.singletonList(".some-other-class"));

Het volgende voorbeeld laat zien hoe je elementen kunt uitsluiten met CSS-iframe-selectoren.

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

inclusief

CSS-selectoren om op te nemen tijdens de analyse

public AxePlaywrightBuilder include(List<String> includeCSS);

Parameters

Naam Type Beschrijving
includeCSS List<String> Een lijst met CSS-selectoren die elementen specificeert die in een toegankelijkheidsanalyse worden opgenomen.

Keert terug

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld laat zien hoe je twee verschillende klassen in de analyse opneemt. Let op hoe het voorbeeld methodechaining gebruikt om meer dan één CSS-klasse te specificeren.

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

Het volgende voorbeeld laat zien hoe je elementen kunt opnemen met CSS-iframe-selectoren.

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

setLegacyMode

Sluit toegankelijkheidsproblemen uit die kunnen optreden in cross-domein frames en iframes.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);
note

Deze API wordt naar verwachting verwijderd in de volgende versie van Axe DevTools.

Keert terug

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld schakelt de legacy-modus in.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

Bied een aangepaste versie van axe-core aan met behulp van Java's File-object

public AxePlaywrightBuilder withAxeSource(File file);

Parameters

Naam Type Beschrijving
bestand Bestand Een bestand met JavaScript dat axe-core implementeert.

Retourwaarden

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld toont hoe u een ander bestand kunt gebruiken voor axe-core in plaats van de meegeleverde versie. Dit hoeft u alleen in speciale gevallen te doen.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

metAxeBron(String)

Geef een aangepaste versie van axe-core met een al geparseerde bron

public AxePlaywrightBuilder withAxeSource(String src);

Parameters

Naam Type Beschrijving
src String Het JavaScript-bronbestand vertegenwoordigd als een String.

Retourwaarden

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld toont hoe u een bestand in een String leest en dat gebruikt als het bronbestand met metAxeBron.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

metAlleenBestPracticeRegels

Controleer op toegankelijkheidsproblemen met alleen de best-practice-regelset ingeschakeld.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Retourwaarden

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld toont hoe u toegankelijkheidsanalyse kunt inschakelen met alleen de best practice regels.


new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

metAlleenExperimenteleRegels

Controleer op toegankelijkheidsproblemen met alleen de experimentele regelset ingeschakeld

public AxePlaywrightBuilder withOnlyExperimentalRules();

Retourwaarden

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld toont hoe u toegankelijkheidsanalyse kunt inschakelen met alleen de experimentele regels.


new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

metRegels

Beperk de regels die tijdens de toegankelijkheidsanalyse worden uitgevoerd tot de gespecificeerde.

public AxePlaywrightBuilder exclude(List<String> rules);

Parameters

Naam Type Beschrijving
regels Lijst<String> Een lijst met regels die voor toegankelijkheidsanalyse worden gebruikt.

Retourwaarden

  • AxePlaywrightBuilder

Voorbeelden

Het volgende voorbeeld toont twee verschillende manieren om de metRegels methode te gebruiken. De eerste maakt een Lijst met één regel, kleurcontrast. De tweede maakt een Lijst met de regels kleurcontrast en afbeelding-alt.

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

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

withTags

Beperkt de toegankelijkheidsanalyse tot de regels of regensets die behoren tot de gespecificeerde tags.

public AxePlaywrightBuilder withTags(List<String> tags);

Parameters

Naam Type Beschrijving
tags Lijst<String> Een lijst van tags die de regels bevatten die u wilt opnemen in de toegankelijkheidsanalyse.

Retourneert

  • AxePlaywrightBuilder

Voorbeelden

Dit voorbeeld laat zien hoe je de toegankelijkheidsanalyse kunt beperken tot regels die behoren tot de gespecificeerde tags. De eerste codefragment toont hoe de analyse kan worden beperkt tot regels die deel uitmaken van de wcag21aa specificatie. Het tweede fragment toont hoe de analyse kan worden beperkt tot de wcag21aa specificatie en de best-practice regels.

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

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

Is this page helpful?

Help us improve this page

Still need help?