API-referentie voor Selenium

Dit document is een referentie voor typen die worden geleverd door het selenium-pakket. De AxeSelenium-klasse moet de meeste gevallen dekken, en AxeConfiguration zou de rest moeten dekken.

com.deque.html.axedevtools.selenium.AxeSelenium

Configureert hoe axe wordt uitgevoerd en voert axe daadwerkelijk uit.

Results = new AxeSelenium()
    .include(".my-css-class")
    .skipping("aria-required-parent")
    .run(driver);

AxeSelenium()

Maak een nieuwe AxeSelenium-toegankelijkheidscontrole voor een AxeDriver.

AxeSelenium(finale AxeBuilder axeBuilder, finale AxeConfiguration axeConfiguration, finale ResultsFilter resultsFilter, finale AxeDevtoolsReporter reporter)

Maak een nieuwe AxeSelenium-toegankelijkheidscontrole voor een AxeDriver.

Resultaten run(finale AxeDriver page)

Voer axe uit op de pagina met behulp van axe.run.

page: AxeDevTools Driver die de pagina vertegenwoordigt waarop een a11y-check moet worden uitgevoerd.

Geeft een resultaatsdocument terug.

AxeSelenium include(finale String cssSelector)

Voeg een enkele selector toe. Om verschillende niet-gerelateerde delen van de pagina te testen, roep include één keer aan voor elk, waarbij je elke keer een enkele selector doorgeeft.

cssSelector: Elke geldige CSS-selector.

Retourneert AxeSelenium voor method chaining.

// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
    .include(".sidebar")
    .include(".some-class")
    .run(driver);

AxeSelenium include(finale List<String> selector)

Voeg een iFrame-selector toe.

selector: Een lijst met geneste iFrame-selectors. Elke selector vertegenwoordigt een CSS-selector voor een niveau van nesting. De laatste vertegenwoordigt een CSS-selector voor het web-element binnen het binnenste iFrame voor controle.

Retourneert AxeSelenium voor method chaining.

Omdat er geen include(String...) overload is, leidt het doorgeven van meer dan één string aan include ook tot een enkele iFrame-selector in plaats van afzonderlijke toevoegingen: include("#parent-iframe", "#html") komt neer op include(Object...) en betekent hetzelfde als het onderstaande voorbeeld.

// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
    .include(Arrays.asList("#parent-iframe", "#html"))
    .run(driver);

include(FromFrames) drukt hetzelfde uit op een explicietere manier en is de aanbevolen vorm voor nieuwe tests.

AxeSelenium include(FromFrames fromFrames)

Voeg een element binnen een of meer geneste iFrames toe, met behulp van een expliciete FromFrames selector.

fromFrames: Een FromFrames selector. Elke selector behalve de laatste komt overeen met een iFrame-niveau; de laatste komt overeen met het element om binnen het binnenste iFrame te testen.

Retourneert AxeSelenium voor method chaining.

// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .include(new FromFrames("#payment-frame", "form"))
    .run(driver);

AxeSelenium include(FromShadowDom fromShadowDom)

Voeg een element binnen een of meer geneste shadow DOM-bomen toe, met behulp van een expliciete FromShadowDom selector.

fromShadowDom: Een FromShadowDom selector. Elke selector behalve de laatste komt overeen met een schaduwhost; de laatste komt overeen met het element om binnen de binnenste shadow root te testen.

Retourneert AxeSelenium voor method chaining.

// Test the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .include(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

AxeSelenium include(Object selector)

Voeg een selector toe die als een enkel object wordt geleverd. Deze overload wordt alleen geselecteerd wanneer het statische type van het argument niet een van de bovenstaande typen is, zoals een variabele gedeclareerd als Object. Geef de voorkeur aan de getypte overloads.

selector: Een CSS-selectorstring, een lijst van strings, een FromFrames selector, of een FromShadowDom selector.

Retourneert AxeSelenium voor method chaining.

AxeSelenium include(Object... selector)

Voeg een selector toe die gewone CSS-selectors mengt met FromFrames of FromShadowDom selectors, voor gevallen die de andere overloads niet kunnen uitdrukken.

Deze overload wordt geselecteerd wanneer de oproep meer dan één argument doorgeeft. Door een enkele FromFrames of FromShadowDom door te geven, selecteert include(FromFrames) of include(FromShadowDom) in plaats daarvan.

Om een iFrame te bereiken dat binnen een shadow root leeft, moet de FromShadowDom selector genest zijn binnen de FromFrames selector; het omgekeerde veroorzaakt een fout.

selector: Een gemengde set van CSS-selectors en selectorobjecten die een enkel pad naar het te testen element vormen.

Retourneert AxeSelenium voor method chaining.

// Test .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .include("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

AxeSelenium exclude(finale String cssSelector)

Sluit een enkele selector uit. Om verschillende niet-gerelateerde delen van de pagina over te slaan, roep exclude één keer aan voor elk, waarbij je elke keer een enkele selector doorgeeft.

cssSelector: Elke geldige CSS-selector.

Retourneert AxeSelenium voor method chaining.

// Skip .cookie-banner and .ad-slot, which are both in the top-level document
Results results = new AxeSelenium()
    .exclude(".cookie-banner")
    .exclude(".ad-slot")
    .run(driver);

AxeSelenium exclude(finale List<String> selector)

Sluit een iFrame-selector uit.

selector: Een lijst met geneste iFrame-selectors. Elke selector vertegenwoordigt een CSS-selector voor een niveau van nesting. De laatste vertegenwoordigt een CSS-selector voor het web-element binnen het binnenste iFrame voor controle.

Retourneert AxeSelenium voor method chaining.

Omdat er geen exclude(String...) overload is, leidt het doorgeven van meer dan één string aan exclude ook tot een enkele iFrame-selector in plaats van afzonderlijke uitsluitingen: exclude(".iframe1", ".third-party-ad") komt neer op exclude(Object...) en betekent hetzelfde als het onderstaande voorbeeld.

// Skip .third-party-ad inside the iframe matched by .iframe1
Results results = new AxeSelenium()
    .exclude(Arrays.asList(".iframe1", ".third-party-ad"))
    .run(driver);

exclude(FromFrames) drukt hetzelfde uit op een explicietere manier en is de aanbevolen vorm voor nieuwe tests.

AxeSelenium exclude(FromFrames fromFrames)

Sluit een element binnen een of meer geneste iFrames uit, met behulp van een expliciete FromFrames selector.

fromFrames: Een FromFrames selector. Elke selector behalve de laatste komt overeen met een iFrame-niveau; de laatste komt overeen met het element om binnen het binnenste iFrame over te slaan.

Retourneert AxeSelenium voor method chaining.

// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .exclude(new FromFrames("#payment-frame", "form"))
    .run(driver);

AxeSelenium exclude(FromShadowDom fromShadowDom)

Sluit een element binnen een of meer geneste shadow DOM-bomen uit, met behulp van een expliciete FromShadowDom selector.

fromShadowDom: Een FromShadowDom selector. Elke selector behalve de laatste komt overeen met een schaduwhost; de laatste komt overeen met het element om binnen de binnenste shadow root over te slaan.

Retourneert AxeSelenium voor method chaining.

// Skip the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .exclude(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

AxeSelenium exclude(Object selector)

Sluit een selector uit die als een enkel object wordt geleverd. Deze overload wordt alleen geselecteerd wanneer het statische type van het argument niet een van de bovenstaande typen is, zoals een variabele gedeclareerd als Object. Geef de voorkeur aan de getypte overloads.

selector: Een CSS-selectorstring, een lijst van strings, een FromFrames selector, of een FromShadowDom selector.

Retourneert AxeSelenium voor method chaining.

AxeSelenium exclude(Object... selector)

Sluit een selector uit die gewone CSS-selectors mengt met FromFrames of FromShadowDom selectors, voor gevallen die de andere overloads niet kunnen uitdrukken.

Deze overload wordt geselecteerd wanneer de oproep meer dan één argument doorgeeft. Door een enkele FromFrames of FromShadowDom door te geven, selecteert exclude(FromFrames) of exclude(FromShadowDom) in plaats daarvan.

Om een iFrame te bereiken dat binnen een shadow root leeft, moet de FromShadowDom selector genest zijn binnen de FromFrames selector; het omgekeerde veroorzaakt een fout.

selector: Een gemengde set van CSS-selectors en selectorobjecten die een enkel pad naar het over te slaan element vormen.

Retourneert AxeSelenium voor method chaining.

// Skip .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .exclude("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

AxeSelenium volgens(finale String... tags)

Volgens toegankelijkheidstags. Controleer alleen de gespecificeerde toegankelijkheidstags. Deze optie is niet compatibel met AxeSelenium::checkingOnly Zie Regelbeschrijvingen.

tags: Lijst van tags voor controle.

Retourneert AxeSelenium voor method chaining.

AxeSelenium controlesAlleen(finale String... regels)

Controleert alleen toegankelijkheidsregels. Deze optie is niet compatibel met AxeSelenium::accordingTo Zie Regelbeschrijvingen.

rules: Lijst van regels voor controle.

Retourneert AxeSelenium voor method chaining.

AxeSelenium controle(finale String... regels)

Controleer toegankelijkheidsregels. Naast de opgegeven tags controleer ook bepaalde regels. Zie Regelbeschrijvingen.

rules: Lijst van regels voor controle.

Retourneert AxeSelenium voor method chaining.

AxeSelenium overslaan(finale String... regels)

Slaat toegankelijkheidsregels over. Binnen de gegeven tags, sla de controle van bepaalde regels over. Zie Regelbeschrijvingen.

rules: Lijst van regels voor controle.

Retourneert AxeSelenium voor method chaining.

AxeSelenium voorConfig(finale URL auditConfigPath)

Voorzie een auditsuite door de URL op te geven.

auditConfigPath: de URL die is gekoppeld aan de auditsuite.

Retourneert AxeSelenium voor method chaining.

AxeSelenium forConfig(final String auditConfigPath) throws MalformedURLException

Biedt een auditsuite aan door de locatie ervan op het bestandssysteem te specificeren.

auditConfigPath: Het absolute bestandspad van de auditsuite.

Retourneert AxeSelenium voor method chaining.

GeeftMalformedURLException als het auditpad een ongeldig bestandssysteem pad is.

AxeSelenium forRuleset(final String rulesetId)

Specificeer een regelset voor de toegankelijkheidscontrole. Het configureren van een auditsuite zal de gespecificeerde regelset wijzigen. Zie Regelsets.

rulesetId: De id van de regelset voor configuratie.

Retourneert AxeSelenium voor method chaining.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Specificeer een regelset voor de toegankelijkheidscontrole. Het configureren van een auditsuite zal de gespecificeerde regelset wijzigen. Zie Regelsets.

rulesetId: De id van de regelset voor configuratie.

enableBestPractices: Of de "best-practice" regels aan- of uitgezet moeten worden.

AxeSelenium: voor method chaining.

AxeSelenium ignoring(final String selector, final String ruleId)

Negeer overtredingen voor een selector en een opgegeven regel-id.

selector: Selector geproduceerd door Axe DevTools Accessibility/Audit suite.

ruleId: Regel-ID die genegeerd moet worden voor de gegeven selector.

Retourneert AxeSelenium voor method chaining.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Log de resultaten van de toegankelijkheidscontrole bij voltooiing.

reportingOptions: Opties die de serialisatie en opslag van de toegankelijkheidscontrole definiëren. Retourneert AxeSelenium voor method chaining.

boolean loggingConfigured()

Of loggen is geconfigureerd of niet.

Retourneert Of loggen is geconfigureerd of niet.

com.deque.html.axecore.args.FromFrames

Een selector die een element binnen een of meer geneste iFrames target. Geef deze door aan AxeSelenium::include of AxeSelenium::exclude.

import com.deque.html.axecore.args.FromFrames;

FromFrames(Object... selectors)

Maak een FromFrames selector.

selectors: Eén selector per niveau van iFrame-nesting, gevolgd door een selector voor het element binnen het binnenste iFrame. Elke invoer is een CSS-selectorstring, of een FromShadowDom selector wanneer het iFrame zelf binnen een shadow root leeft.

List<Object> getFromFrames()

Haalt de selectors op die het pad door de geneste iFrames vormen.

Geeft de lijst met selectors terug.

void setFromFrames(Object... fromFrames)

Stelt de selectors in die het pad door de geneste iFrames vormen.

fromFrames: De te gebruiken selectors.

com.deque.html.axecore.args.FromShadowDom

Een selector die een element binnen een of meer geneste shadow DOM-bomen target. Geef deze door aan AxeSelenium::include of AxeSelenium::exclude.

import com.deque.html.axecore.args.FromShadowDom;

FromShadowDom(String... selectors)

Maak een FromShadowDom selector.

selectors: Eén selector per niveau van shadow DOM-nesting, gevolgd door een selector voor het element binnen de binnenste shadow root.

Lijst<String> getFromShadowDom()

Haalt de selectors op die het pad door de geneste shadow roots vormen.

Geeft de lijst van selectors terug.

void setFromShadowDom(String... fromShadowDom)

Stelt de selectors in die het pad door de geneste shadow roots vormen.

fromShadowDom: De te gebruiken selectors.

com.deque.html.axedevtools.selenium.AxeDriver

Interacteer met een pagina met AxeDriver.

Omvat selenium web driver om specifieke functionaliteit van axe-DevTools te bieden.

AxeDriver(final WebDriver webDriver)

Maak een AxeDriver van een Selenium WebDriver.

webDriver: Een Selenium WebDriver voor de pagina die gecontroleerd moet worden.

com.deque.html.axedevtools.selenium.AxeConfiguration

Configureer axe-script eigenschappen zoals bestandslocatie en configuratie. Singleton-klasse, gebruik AxeConfiguration.configure() om toegang te krijgen.

// Code runs once before any tests are run
public void setupOnce() {
  AxeConfiguration.configure()
    .withAxeScript(axeURL)
    .forAuditPath(auditURL)
    .forRuleset("508")
    .outputDirectory("my-axe-results");
}

static AxeConfiguration configure()

Configureer een axe toegankelijkheidscontrole. De enige manier om een AxeConfiguration exemplaar te verkrijgen.

Retourneert Een configuratie-object om de auditsuite globaal te configureren.

static void reset()

Herstelt naar standaardvoorkeuren.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Voorzie een auditsuite door de URL op te geven.

auditConfigPath: de URL die is gekoppeld aan de auditsuite.

Geeft AxeConfiguration terug voor method chaining.

AxeConfiguration voorAuditSuite(final String auditConfigPath) throws MalformedURLException

Biedt een auditsuite aan door de locatie ervan op het bestandssysteem te specificeren.

auditConfigPath: Het absolute bestandspad van de auditsuite.

Geeft AxeConfiguration terug voor method chaining.

GeeftMalformedURLException als het auditpad een ongeldig bestandssysteem pad is.

AxeConfiguration metAxeScript(URL axeScript)

Biedt een axe-core script aan dat gebruikt zal worden voor het uitvoeren van de toegankelijkheidscontrole.

axeScript: De URL die hoort bij het axe-core script dat gebruikt zal worden voor de toegankelijkheidscontrole.

Geeft AxeConfiguration terug voor method chaining.

AxeConfiguration voorRuleset(final String rulesetId)

Kies welke regels die uitgevoerd moeten worden

rulesetId: Eén van:

• wcag2
• wcag2.1
• wcag2.2
• wcag2aaa
• wcag2.1aaa
• wcag2.2aaa
• 508
• ttv5
• en301549
• rgaav4

Geeft AxeConfiguration terug voor method chaining.

AxeConfiguration voorRuleset(final String rulesetId, final boolean enableBestPractices)

Kies welke regels die uitgevoerd moeten worden

rulesetId: Zieboven voor mogelijke waarden.

enableBestPractices: Of de "best-practice" regels aan- of uitgezet moeten worden.

Geeft AxeConfiguration terug voor method chaining.

String getTestSuiteName()

Haalt de naam van de testsuite op.

Geeft de naam van de testsuite terug.

AxeConfiguration testSuiteName(final String testSuiteName)

Stelt de naam van de testsuite in. Gebruikt bij het genereren van rapporten.

testSuiteName: De naam van de testsuite.

Geeft AxeConfiguration terug voor method chaining.

String getOutputDirectory()

Haalt de rapportuitvoermap op.

Geeft het pad van de uitvoermap terug.

AxeConfiguration outputDirectory(final String outputDirectory)

Stelt de map in waar rapporten in opgeslagen worden.

outputDirectory: Het pad naar de map.

Geeft AxeConfiguration terug voor method chaining.

String getUserAgent()

Haalt de waarde op die gebruikt wordt als user-agent.

Geeft de user-agent terug die gebruikt wordt bij het genereren van rapporten.

AxeConfiguration userAgent(final String userAgent)

Stelt de waarde in die wordt gebruikt als user-agent bij het genereren van een rapport. Dit beïnvloedt niet de daadwerkelijke user-agent die wordt gebruikt bij het draaien van axe.

userAgent: De waarde van de user-agent.

Geeft AxeConfiguration terug voor method chaining.

String getTestMachine()

Haalt de naam van de testmachine op.

Geeft de naam van de testmachine terug.

AxeConfiguration testMachine(final String testMachine)

Stelt de naam van de testmachine in. Gebruikt bij het genereren van rapporten.

testMachine: De naam van de testmachine.

Geeft AxeConfiguration terug voor method chaining.

com.deque.html.axedevtools.selenium.results.IgnoredViolation

IgnoredViolation(final String cssSelector, final String ruleId)

Maak een te negeren overtreding aan.

cssSelector: Selector van de node om te negeren. Vergelijkt met het doel van elke node.

ruleId: ID van de regel om te negeren

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions implements ReportingOptions

Configureert rapportageopties. Neemt standaarden uit AxeConfiguration over.

AxeReportingOptions()

Creëert een AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Haalt de standaardopties op.

Geeft een object met standaardopties terug.

String getSuiteTestName()

Haalt de geconfigureerde naam van de testsuite op.

Geeft de naam terug.

AxeReportingOptions testSuiteName(final String testSuiteName)

Beschrijft de testsuite.

testSuiteName: Naam van de testsuite.

Geeft ReportingOptions terug voor method chaining.

String getUiState()

Haalt de geconfigureerde UI-status op.

Geeft de status terug.

AxeReportingOptions uiState(final String uiState)

Beschrijft de status van de UI tijdens de toegankelijkheidscontrole.

uiState: Status van de UI.

Geeft ReportingOptions terug voor method chaining.

String getOutputDirectory()

Haalt de geconfigureerde uitvoermap op.

Geeft de map terug.

AxeReportingOptions outputDirectory(final String outputDirectory)

Stel de root uitvoermap in om het toegankelijkheidsrapport te genereren.

outputDirectory: Directory pad.

Geeft ReportingOptions terug voor method chaining.

String getFileName()

Berekende bestandsnaam van geconfigureerde waarden.

Geeft de bestandsnaam terug.

String getFilePath(final String extension)

Berekent het bestandspad van geconfigureerde waarden.

Geeft het pad terug.

String getUserAgent()

Haalt de geconfigureerde user agent op.

Geeft de user agent terug.

AxeReportingOptions userAgent(final String userAgent)

Beschrijf de user agent die gebruikt wordt om de toegankelijkheidstest uit te voeren.

userAgent: Naam van de user agent.

Geeft ReportingOptions terug voor method chaining.

String getTestMachine()

Haalt de geconfigureerde testmachine op.

Geeft de testmachine terug.

AxeReportingOptions testMachine(final String testMachine)

Beschrijf de machine die gebruikt wordt om de toegankelijkheidstest uit te voeren.

testMachine: Naam van de machine.

Geeft ReportingOptions terug voor method chaining.

AxeReportingOptions lineNum(final String lineNum)

Specificeer het regelnummer van de huidige test.

lineNum: Regelnummer van de huidige test.

Geeft ReportingOptions terug voor method chaining.

ReportingOptions lineNumIfEmpty(final String lineNum)

Specificeer het regelnummer, als het nog niet is ingesteld.

lineNum: Regelnummer van de huidige test.

Geeft ReportingOptions terug voor method chaining.

com.deque.html.axedevtools.selenium.reporter.MissingUIStateException

Uitzondering voor wanneer de UI-status ontbreekt.

com.deque.html.axedevtools.selenium.results.ResultsFilter

Stelt overtredingen in die genegeerd moeten worden.

ResultsFilter filter = new ResultsFilter()
    .ignoring(".third-party-iframe", "label");
Results results = new AxeSelenium(axe, configuration, filter, reporter)
    .run(driver);

Results filterIgnoredViolations(final Results results)

Filter resultaten om genegeerde overtredingen te verwijderen.

results: Te filteren resultaten.

Geeft binnenkomende resultaten terug, gefilterd voor genegeerde CSS Selectors + Regel-ID's.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Voeg een genegeerde overtreding toe.

cssSelector: CSS-selector geproduceerd door het uitvoeren van de Toegankelijkheid / Audit suite.

ruleId: Regel-ID geproduceerd door het uitvoeren van de Toegankelijkheid / Audit suite.

Geeft ResultsFilter terug voor method chaining.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configureer rapportageopties bij gebruik van hamcrest matchers.

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));

AxeDevtoolsReporter()

Maak een AxeDevtoolsReporter aan.

String generateReport(final Results results, final String executedCommand)

Creëer een stringrepresentatie van de toegankelijkheidscontrole.

results: Resultaten van de auditcontrole.

executedCommand: Uitgevoerde opdracht om auditresultaten te produceren.

Geeft een leesbaar rapport van gevonden toegankelijkheidsovertredingen terug.

void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)

Rapporteer over de toegankelijkheidscontrole. Voeg rapport toe aan resultaatlogbestand per datum. Bewaar volledige resultaten als JSON-bestand.

reportingOptions: Opties voor het loggen van het rapport.

results: Resultaten van de auditcontrole.

executedCommand: Uitgevoerde opdracht om auditresultaten te produceren.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Genereert een TestResults van een Results en ReportingOptions. Gebruikt met de AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Genereert de {@link TestResults}.

reportingOptions: Opties waarmee we onze resultaten creëren.

results: Resultaten van het uitvoeren van axe.

Retourneert De test

com.deque.html.axedevtools.reporter.ViolationsReporter

Rapporteert alleen overtredingen.

com.deque.html.axedevtools.utils.FileUtils

Bestandshulpprogramma's voor intern gebruik.