Cypress 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 APIs in het @axe-devtools/cypress pakket

Not for use with personal data

Cypress Chainable Commands (analyseren)

`cy.axeAnalyze()`

Deze chainable command injecteert axe in alle pagina's en iframes en voert vervolgens axe op de pagina uit.

Parameter	Type	Standaardwaarde	Beschrijving
naam (optioneel)	String	ongedefinieerd	Stelt de identifier in voor dit scanresultaat dat wordt opgeslagen in het rapport. Standaard is een timestamp als niet opgegeven.
context (optioneel)	axe.ElementContext	ongedefinieerd	Definieert de reikwijdte van de analyse—het deel van de DOM dat u wilt analyseren. Dit zal meestal het document zijn of een specifieke selector zoals klasnaam, ID, selector, enz.
opties (optioneel)	axe.RunOptions	ongedefinieerd	Set van opties doorgegeven aan regels of controles, waardoor deze tijdelijk worden aangepast. Dit staat in contrast met `axe.configure`, wat meer permanent is.
log (optioneel)	Boolean	false	Geeft output terug naar stdout met het aantal elementen die niet toegankelijk zijn en de schendingseffecten als een tabel.

`cy.isAxeClean()`

Deze chainable command is een bewering dat de pagina geen toegankelijkheidsfouten heeft.

Parameters:

Parameter	Type	Standaardwaarde	Beschrijving
context (optioneel)	axe.ElementContext	ongedefinieerd	Definieert de reikwijdte van de analyse—het deel van de DOM dat u wilt analyseren. Dit zal meestal het document zijn of een specifieke selector zoals klasnaam, ID, selector, enz.
opties (optioneel)	axe.RunOptions	ongedefinieerd	Set van opties doorgegeven aan regels of controles, waardoor deze tijdelijk worden aangepast. Dit staat in contrast met `axe.configure`, wat meer permanent is.

Cypress Chainable Commands (configuratie)

Integreer Axe DevTools voor Web met Cypress met behulp van aangepaste Cypress chainable commands om geanalyseerde resultaten te configureren.

`cy.setAxeSource()`

Deze chainable command stelt de versie van axe-core in.

Parameter	Type	Standaardwaarde	Beschrijving
Bestandspad (verplicht)	String	nul	Pad relatief aan de root van het project dat zou moeten bevatten `axe.source` of geminificeerde versie van axe-core.

`cy.setAxeCustom()`

Deze ontkoppelbare commando laat het gebruik van aangepaste regels toe.

Axe DevTools voor Web Cypress zal ook impliciet lezen axe-ruleset.json wanneer geplaatst op het rootniveau van het project of zal ook aangepaste regelsbestanden gebruiken wanneer de AXE_RULESET_PATH omgevingsvariabele is ingesteld.

Parameter	Type	Standaardwaarde	Beschrijving
Bestandspad (verplicht)	String	nul	Pad relatief aan de root van het project dat controles en regels moet bevatten

`cy.setAxeRuleset()`

Deze ontkoppelbare commando stelt gebruikers in staat om regels per tags te draaien, vergelijkbaar met configureren axe.run().

Parameter	Type	Standaardwaarde	Beschrijving
regels (verplicht)	'508', 'en301549', 'rgaav4', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	'wcag2.1'	Array van tags waaraan deze regel is toegewezen.

`cy.setAxeReportName()`

Deze ontkoppelbare commando stelt gebruikers in staat om de naam van het rapportbestand in te stellen.

Parameter	Type	Standaardwaarde	Beschrijving
rapportNaam (verplicht)	String	@axe-devtools-cypress	Naam van het rapportbestand.

`cy.getAxeResults()`

Deze ontkoppelbare commando stelt gebruikers in staat om de resultaten te gebruiken na het uitvoeren van cy.axeAnalyze().

Antwoorden van getAxeResults() retourneert de gegevensstructuur axe.AxeResults.

Voorbeeld:

after(() => {
  cy.axeAnalyze();
  cy.getAxeResults().then(data => {
    cy.writeFile('./results.json', data)
  })
})

`cy.getUniversalResults()`

Deze ontkoppelbare commando retourneert de resultaten van de meest recente cy.axeAnalyze() -oproep in het Axe Universal Format. Retourneert null als er nog geen analyse is uitgevoerd.

Voorbeeld:

after(() => {
  cy.axeAnalyze();
  cy.getUniversalResults().then(data => {
    cy.writeFile('./results-universal.json', data)
  })
})

Gebruiksservice

De gebruiksservice stelt je in staat inzicht te krijgen in de gebruikstrends van Axe DevTools for Web binnen je organisatie.

Omgevingsvariabelen

Deze omgevingsvariabelen stellen je in staat de gebruiksservice 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

`cy.task('enableTracking', <boolean>)`

Deze cypress-taak stelt gebruikers in staat om toestemming te geven voor het verzenden van gegevens naar de gebruiksservice.

`cy.task('setTrackingUrl', <string>)`

Deze cypress-taak stelt gebruikers in staat om te veranderen waar de gegevens voor gebruiksstatistieken naartoe worden gestuurd.

`cy.task('setDistinctId', <string>)`

Deze cypress-taak stelt gebruikers in staat om de unieke id die wordt opgeslagen of gebruikt te wijzigen.

Volgende stappen

Als je problemen hebt met het installeren van Axe DevTools for Web, neem dan direct contact op met je Deque-vertegenwoordiger, vraag het ons via onze ondersteuningsdesk, of stuur ons een e-mail. We helpen je graag op weg.