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

Commandes enchaînables Cypress (analyser)

`cy.axeAnalyze()`

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

Paramètre	Type	Valeur par défaut	Description
nom (optionnel)	Chaîne	non défini	Définit l'identifiant pour ce résultat d'analyse stocké dans le rapport. Par défaut, utilise un timestamp si non fourni.
contexte (optionnel)	axe.ElementContext	non dé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 classe, l'ID, le sélecteur, etc.
options (optionnel)	axe.RunOptions	non défini	Ensemble d'options passées dans les règles ou vérifications, les modifiant temporairement. Ceci contraste avec `axe.configure`, qui est plus permanent.
log (optionnel)	Booléen	faux	Retourne une sortie dans stdout avec le nombre d'éléments non accessibles et les impacts de violation sous forme de tableau.

`cy.isAxeClean()`

Cette commande enchaînable est une assertion que la page ne présente aucune violation d'accessibilité.

Paramètres :

Paramètre	Type	Valeur par défaut	Description
contexte (optionnel)	axe.ElementContext	non dé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 classe, l'ID, le sélecteur, etc.
options (optionnel)	axe.RunOptions	non défini	Ensemble d'options passées dans les règles ou vérifications, les modifiant temporairement. Ceci contraste avec `axe.configure`, qui est plus permanent.

Commandes enchaînables Cypress (configuration)

Intégrez Axe DevTools pour le Web avec Cypress en utilisant des commandes enchaînables Cypress personnalisées pour configurer les résultats analysés.

`cy.setAxeSource()`

Cette commande enchaînable définit la version de axe-core.

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

`cy.setAxeCustom()`

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

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

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

`cy.setAxeRuleset()`

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

Paramètre	Type	Valeur par défaut	Description
jeu de règles (obligatoire)	'508', 'en301549', 'rgaav4', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	'wcag2.1'	Tableau de tags auxquels cette règle est assigné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
nom du rapport (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 exécution cy.axeAnalyze().

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

Exemple :

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

`cy.getUniversalResults()`

Cette commande chaînable retourne les résultats de la plus récente cy.axeAnalyze() appel dans le Format Universel Axe. Retourne null si aucune analyse n'a encore été effectuée.

Exemple :

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

Service d'utilisation

Le service d'utilisation vous permet de comprendre les tendances d'utilisation d'Axe DevTools pour le Web au sein de votre organisation.

Variables d'environnement

Ces variables d'environnement vous permettent de configurer le service d'utilisation et de modifier les propriétés des événements signalés.

Nom	Type	Peut remplacer	Description
`AXE_DISTINCT_ID`	Chaîne de caractères	—	Un identifiant UUID qui reste le même pour l'utilisateur connecté (sauf s'il est régénéré)
`AXE_METRICS_URL`	Chaîne de caractères	—	L'URL du point d'accès REST pour l'utilisation
`AXE_TRACK_USAGE`	Booléen	—	Active le rapport de service d'utilisation (par défaut est `false`)
`AXE_APPLICATION`	Chaîne de caractères	faux	L'application qui a été utilisée pour vérifier les erreurs d'accessibilité
`AXE_DEV_INSTANCE`	Booléen	vrai	Indique si cet événement provient d'actions d'un développeur logiciel. Utile pour marquer et supprimer ensuite les événements enregistrés pendant le développement ou les tests.
`AXE_DEPARTMENT`	Chaîne de caractères	vrai	Le département de l'utilisateur au sein de l'organisation
`AXE_KEYCLOAK_ID`	Chaîne de caractères	faux	L'ID Keycloak de l'utilisateur
`AXE_LOGGED_IN`	Booléen	faux	Enregistre si l'utilisateur est connecté à l'application en test
`AXE_ORGANIZATION`	Chaîne de caractères	vrai	L'organisation de l'utilisateur
`AXE_SESSION_ID`	Chaîne de caractères	faux	Un UUID identifiant la session de l'utilisateur
`AXE_USER_ID`	Chaîne de caractères	faux	L'identité spécifique de l'utilisateur, comme le nom ou l'ID de connexion
`AXE_USER_JOB_ROLE`	Chaîne de caractères	faux	Le rôle professionnel de l'utilisateur
`AXE_USER_STATUS`	Chaîne de caractères	faux	Informations de statut que vous souhaitez associer à l'utilisateur

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

Cette tâche Cypress permet aux utilisateurs de choisir d'envoyer des données au service d'utilisation.

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

Cette tâche Cypress permet aux utilisateurs de modifier le lieu d'envoi des données de métriques d'utilisation.

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

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

Prochaines étapes

Si vous rencontrez des problèmes lors de l'installation d'Axe DevTools pour le Web, contactez directement votre représentant Deque, demandez-nous via notre service d'assistance, ou envoyez-nous un email. Nous serons ravis de vous aider à démarrer.