Référence de l'API Cypress pour axe DevTools for 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

Référence pour les API du package @axe-devtools/cypress

Not for use with personal data

Cypress Chainable Commands (analyze)

`cy.axeAnalyze()`

Cette commande chaînable injecte axe dans toutes les pages et iframes, puis s'exécute axe sur la page.

Paramètre	Type	Valeur par défaut	Description
Contexte (facultatif)	axe.ElementContext	indéfini	Définit la portée de l'analyse : la partie du DOM que vous souhaitez analyser. Il s'agira généralement du document ou d'un sélecteur spécifique tel que le nom de la classe, l'ID, etc.
options (optionnel)	axe.RunOptions	indéfini	Ensemble d'options passées dans des règles ou des contrôles, les modifiant temporairement. Cela contraste avec `axe.configure`, qui est plus permanent.
log (facultatif)	Booléen	false	Renvoie la sortie vers stdout avec le nombre d'éléments qui ne sont pas accessibles et les impacts de la violation sous forme de tableau.

`cy.isAxeClean()`

Cette commande chaînable est une affirmation selon laquelle la page ne présente aucune violation d'accessibilité.

Paramètres :

Paramètre	Type	Valeur par défaut	Description
Contexte (facultatif)	axe.ElementContext	indéfini	Définit la portée de l'analyse : la partie du DOM que vous souhaitez analyser. Il s'agira généralement du document ou d'un sélecteur spécifique tel que le nom de la classe, l'ID, etc.
options (optionnel)	axe.RunOptions	indéfini	Ensemble d'options passées dans des règles ou des contrôles, les modifiant temporairement. Cela contraste avec `axe.configure`, qui est plus permanent.

Cypress Chainable Commands (configuration)

Intégrez axe DevTools for Web avec Cypress à l'aide de commandes enchaînées Cypress personnalisées pour configurer les résultats analysés.

`cy.setAxeSource()`

Cette commande chaînable définit la version de hache.

Paramètre	Type	Valeur par défaut	Description
Chemin du fichier (obligatoire)	Chaîne	nul	Chemin relatif à la racine du projet qui doit inclure une version minifiée de axe. `axe.source`

`cy.setAxeCustom()`

Cette commande chaînable permet l'utilisation d'ensembles de règles personnalisés.

axe DevTools for Web Cypress lira également implicitement axe-ruleset.json lorsqu'il sera placé au niveau racine du projet ou utilisera également des fichiers de règles personnalisés lorsque la AXE_RULESET_PATH variable d'environnement est définie.

Paramètre	Type	Valeur par défaut	Description
Chemin du fichier (obligatoire)	Chaîne	nul	Chemin relatif à la racine du projet qui doit inclure des vérifications et des règles

`cy.setAxeRuleset()`

Cette commande chaînable permet aux utilisateurs d'exécuter des règles par balises, de manière similaire à la configuration axe.run().

Paramètre	Type	Valeur par défaut	Description
Ensemble de règles (obligatoire)	'508', 'en301549', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	« wcag2.1 »	Tableau de balises auxquelles cette règle est attribuée.

`cy.setAxeReportName()`

Cette commande chaînable permet aux utilisateurs de définir le nom du fichier de rapport.

Paramètre	Type	Valeur par défaut	Description
reportName (obligatoire)	Chaîne	@axe-devtools-cypress	Nom du fichier de rapport.

`cy.getAxeResults()`

Cette commande chaînable permet aux utilisateurs d'utiliser les résultats après l'exécution cy.axeAnalyze().

Les réponses de getAxeResults() renvoient la structure de données axe.AxeResults.

Exemple :

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

Service d'utilisation

Le service d'utilisation vous permet d'obtenir un aperçu des tendances d'utilisation d'axe DevTools for Web au sein de votre organisation.

Variables d’environnement

Cette méthode permet aux utilisateurs de modifier des valeurs spécifiques du service d'utilisation via des variables d'environnement

Variable d'environnement	Type
AXE_IS_LOGGED_IN	Booléen
AXE_KEYCLOAK_ID	Chaîne
AXE_USER_ID	Chaîne
AXE_SESSION_ID	Chaîne
AXE_STATUT_UTILISATEUR	Chaîne
AXE_RÔLE_PROFESSIONNEL_UTILISATEUR	Chaîne
AXE_DISTINCT_ID	Chaîne
AXE_IS_DEV_INSTANCE	Booléen
AXE_ORGANISATION	Chaîne
AXE_APPLICATION	Chaîne
AXE_METRICS_URL	Chaîne
AXE_TRACK_USAGE	Booléen

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

Cette tâche Cypress permet aux utilisateurs d'accepter l'envoi de données au service d'utilisation.

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

Cette tâche Cypress permet aux utilisateurs de modifier l'endroit où les données des mesures d'utilisation sont envoyées.

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

Cette tâche Cypress permet aux utilisateurs de modifier l'identifiant distinct stocké ou utilisé.

Prochaines étapes

Si vous rencontrez des problèmes lors de l'installation d'axe DevTools for Web, contactez directement votre représentant Deque, demandez-nous via notre service d'assistance ou envoyez-nous un e-mail. Nous serons heureux de vous aider à mettre en marche.