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 chaî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. Cela 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. Cela 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 une 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 règles personnalisées lorsque la variable d'environnement AXE_RULESET_PATH 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, de manière similaire à la configuration de 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 l'exécution de 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)
  })
})

`cy.getUniversalResults()`

Cette commande chaînable retourne les résultats du dernier appel cy.axeAnalyze() 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é). En Ruby, cette variable est nommée `DEQUE_DISTINCT_ID`.
`AXE_INCLUDE_TEST_RESULTS`	Booléen	—	Définir sur `true` pour inclure les résultats complets de axe-core dans l'objet `testResults` de chaque événement (la valeur par défaut est `false`). Pris en charge uniquement par la CLI et les API Node.js.
`AXE_METRICS_URL`	Chaîne de caractères	—	L'URL du point de terminaison de l'utilisation REST (la valeur par défaut est `https://usage.deque.com`)
`AXE_TRACK_USAGE`	Booléen	—	Définir sur `false` pour désactiver le rapport de service d'utilisation. Le rapport est activé par défaut.
`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. Pour que votre utilisation apparaisse dans Axe Reports, définissez ceci sur l'ID de votre organisation (contactez Deque pour l'obtenir).
`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é d'un utilisateur spécifique, telle qu'une adresse e-mail, un nom ou un identifiant de connexion. Axe Reports compte les utilisateurs uniques à partir de cette valeur.
`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 ou non des données au service d'utilisation. L'envoi est activé par défaut.

`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 avez des problèmes pour installer Axe DevTools pour le Web, contactez directement votre représentant Deque, posez-nous vos questions via notre service d'assistance, ou envoyez-nous un email. Nous serons heureux de vous aider à démarrer.