WebdriverIO API-referentie voor Axe DevTools voor Web

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

Referentie voor de API's in het @axe-devtools/webdriverio-pakket

Not for use with personal data

Constructor

In de standaardconfiguratie is het enige argument dat aan de WebdriverIO-constructor moet worden doorgegeven, de WebdriverIO-instantie. Als je een andere versie van axe-core wilt gebruiken dan de oorspronkelijk meegeleverde of een aangepaste regels, kun je deze opties in de constructor doorgeven.

note

Je kunt geen niet-standaard axe-core versie selecteren en een aangepaste regels.

AxeDevToolsWebdriverIO(options: Options)

De Options interface is een object dat de volgende eigenschappen bevat:

client (vereist): een WebdriverIO-client
axeSource (optioneel): een string van axe-core broncode
rulesetID (optioneel): een regels-ID ('wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa', '508', 'en301549', 'rgaav4', 'ttv5')

note

Je mag niet zowel axeSource als rulesetIDgebruiken. De twee sluiten elkaar uit.

De versie van axe-core definiëren

Standaard zal @axe-devtools/webdriverio de nieuwste beschikbare versie van axe-core gebruiken. Om een andere versie van axe-core te configureren, geef de axeSource optie door. Alle axe-core versies kunnen worden opgehaald via npm of via unpkg door te gaan naar http://unpkg.com/axe-core@<version>/axe.js (vervang <version> door het versienummer). Alle axe-core versies na 2.1.0 worden ondersteund.

Dit is een voorbeeld van het initialiseren van Axe DevTools WebdriverIO met axe-core 2.3.0 vanuit een bestand in de bovenliggende map van het testbestand.

const axeSource = require('../axe-core-3.5.0').source;
const axeDevTools = new AxeDevToolsWebdriverIO({ client, axeSource });

analyze-methode

Deze methode voert de analyse uit en retourneert uiteindelijk de resultaten van de toegankelijkheidsscan.

analyze(client: webdriverio.Client): Promise<axe.AxeResults>

Voer een analyse uit met de standaardconfiguratie op de gegeven client. Een Promise wordt geretourneerd, wat zich oplost met het resultaat dat door axe-core wordt geretourneerd.

Aangepaste regels

Voor informatie over het gebruik van aangepaste regels met Axe DevTools, lees de handleiding over het genereren en integreren van aangepaste regels in de CLI-handleiding.

analyzeUniversal-methode

Voert een analyse uit en retourneert de resultaten in het Axe Universal Format. De bestaande analyze() methode blijft ongewijzigd.

analyzeUniversal(): Promise<UniversalExport>

Keten Opties

Er zijn verschillende opties voor het afbakenen van je Axe DevTools-scans. Je kunt specifieke CSS-scopes opnemen of uitsluiten en/of iframes negeren. De ketenmethode (hieronder) op de constructor maakt dit mogelijk.

disableFrame

AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIO

Schakel het injecteren van axe-core in frames die overeenkomen met de gegeven CSS-selector uit. Deze methode kan meerdere keren worden aangeroepen.

include

AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO

Selector die in de analyse moet worden opgenomen. Dit kan meerdere keren worden aangeroepen.

exclude

AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIO

Selector die in de analyse moet worden uitgesloten. Dit kan meerdere keren worden aangeroepen.

Regelconfiguratie

Deze opties wijzigen de regelconfiguratie voor de gekozen regels. Deze opties overschrijven de standaardregelconfiguratie en zullen je resultaten aanpassen. Aanvullende oproepen met deze methoden overschrijven eerdere oproepen.

withRules

AxeDevToolsWebdriverIO.withRules(rules: RuleID[]): AxeDevToolsWebdriverIO

Beperk de analyse tot alleen de gespecificeerde regels. Kan niet worden gebruikt met AxeDevToolsWebdriverIO.withTags().

withTags

AxeDevToolsWebdriverIO.withTags(tags: axe.TagValue[]): AxeDevToolsWebdriverIO

Beperk de analyse tot alleen de gespecificeerde tags. Kan niet worden gebruikt met AxeDevToolsWebdriverIO.withRules().

disableRules

AxeDevToolsWebdriverIO.disableRules(rules: RuleID[]): AxeDevToolsWebdriverIO

Stel de lijst met regels in die worden overgeslagen bij het uitvoeren van een analyse.

axe-core Opties

Deze opties geven toegang tot de onderliggende axe-core configuratie. Voor meer informatie over deze opties, zie de axe-core documentatie.

configureren

AxeDevToolsWebdriverIO.configure(config: axe.Spec): AxeDevToolsWebdriverIO

Stel de configuratie voor axe-core in. Deze waarde wordt direct doorgegeven aan axe.configure().

opties

AxeDevToolsWebdriverIO.options(runOptions: axe.RunOptions): AxeDevToolsWebdriverIO

De runOptions om direct door te geven aan axe.run(). Zie de axe-core documentatie voor gebruik. Zal eventuele andere geconfigureerde opties overschrijven, inclusief oproepen naar AxeDevToolsWebdriverIO.withRules() en AxeDevToolsWebdriverIO.withTags().

Gebruik Dienst

De gebruiksdienst stelt u in staat inzicht te krijgen in trends in het gebruik van Axe DevTools binnen uw organisatie.

Standaard is de gebruiksdienst uitgeschakeld, en de standaard-URL is https://usage.deque.com.

Omgevingsvariabelen

Deze omgevingsvariabelen stellen u in staat om de gebruiksdienst te configureren en de eigenschappen van gerapporteerde gebeurtenissen te wijzigen.

Naam	Type	Kan Override	Beschrijving
`AXE_DISTINCT_ID`	String	—	Een UUID-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze wordt opnieuw gegenereerd)
`AXE_METRICS_URL`	String	—	De URL van het REST-gebruikseindpunt
`AXE_TRACK_USAGE`	Boolean	—	Stelt het gebruik van dienstrapportage in (standaard is `false`)
`AXE_APPLICATION`	String	false	De applicatie die werd gebruikt om toegankelijkheidsfouten te controleren
`AXE_DEV_INSTANCE`	Boolean	true	Geeft aan of dit evenement afkomstig is van acties van een softwareontwikkelaar. Nuttig voor het markeren en later verwijderen van evenementen die tijdens ontwikkeling of testen zijn geregistreerd.
`AXE_DEPARTMENT`	String	true	De afdeling van de gebruiker binnen de organisatie
`AXE_KEYCLOAK_ID`	String	false	De Keycloak-ID van de gebruiker
`AXE_LOGGED_IN`	Boolean	false	Registreert of de gebruiker is ingelogd op de toepassing onder test
`AXE_ORGANIZATION`	String	true	De organisatie van de gebruiker
`AXE_SESSION_ID`	String	false	Een UUID die de sessie van de gebruiker identificeert
`AXE_USER_ID`	String	false	De identiteit van een specifieke gebruiker, zoals naam of inlog-ID
`AXE_USER_JOB_ROLE`	String	false	De functie van de gebruiker
`AXE_USER_STATUS`	String	false	Statusinformatie die u aan de gebruiker wilt koppelen

enableTracking

Met deze methode kunnen gebruikers ervoor kiezen om gegevens naar de gebruiksdienst te versturen

.enableTracking(state: boolean): AxeDevToolsWebdriverIO

setTrackingUrl

Met deze methode kunnen gebruikers wijzigen waar de gebruiksmetrische data naartoe worden gestuurd

.setTrackingUrl(url: string): AxeDevToolsWebdriverIO

setDistinctId

Met deze methode kunnen gebruikers de opgeslagen/gebruikt specifieke id wijzigen

.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO