Référence de l'API WebdriverIO pour axe DevTools for Web

Constructeur

Dans la configuration standard, le seul argument devant être transmis au constructeur WebdriverIO est l'instance WebdriverIO. Si vous souhaitez utiliser une version d'axe-core différente de celle incluse à l'origine ou un ensemble de règles personnalisé, vous pouvez transmettre ces options au constructeur.

AxeDevToolsWebdriverIO(options: Options)

L' Options interface est un objet qui contient les propriétés suivantes :

• client (obligatoire) : un client WebdriverIO
• axeSource (facultatif) : une chaîne de code source d'axe-core
• rulesetID (facultatif) : un identifiant d'ensemble de règles ('wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa', '508', 'en301549', 'ttv5')

Définition de la version axe-core

Par défaut, @axe-devtools/webdriverio utilisera la dernière version disponible d'axe-core. Pour configurer une version différente d'axe-core, introduisez l'option axeSource . Toutes les versions d'axe-core peuvent être récupérées à partir de npm ou via unpkg en visitant http://unpkg.com/axe-core@<version>/axe.js remplacez (remplacer <version> avec le numéro de version). Toutes les versions d'axe-core après 2.1.0 sont prises en charge.

Ceci est un exemple d'initialisation d'axe DevTools avec axe-core 2.3.0 à partir d'un fichier situé dans le répertoire parent du fichier de test.

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

Méthode d'Analyse

Cette méthode exécute l’analyse et renvoie finalement les résultats de l’analyse d’accessibilité.

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

Exécute une analyse en utilisant la configuration par défaut sur le client donné. Un [missing term] Promise est renvoyé, qui se résout avec l'ensemble de résultats renvoyé par axe-core.

Règles personnalisées

Pour plus d'informations sur l'utilisation de règles personnalisées avec axe DevTools, lisez le guide sur la génération et l'intégration de jeux de règles personnalisés dans le guide CLI.

Options de chaîne de traitement

Plusieurs options existent pour définir la portée de vos analyses axe DevTools. Vous pouvez inclure ou exclure des portées CSS spécifiques et/ou ignorer les iframes. Les méthodes de chaîne (ci-dessous) sur le constructeur rendent cela possible.

Désactiver le cadre

AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIO

Désactiver l'injection d'axe-core dans les cadres correspondant au sélecteur CSS donné. Cette méthode peut être appelée un nombre quelconque de fois.

comprend

AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO

Sélecteur à inclure dans l'analyse. Cela peut être appelé un nombre quelconque de fois.

exclure

AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIO

Sélecteur exclure dans l'analyse. Cela peut être appelé un nombre quelconque de fois.

Configuration des règles

Ces options modifient la configuration des règles pour l'ensemble de règles choisi. Ces options remplacent la configuration de règle standard et modifieront vos résultats. Les appels supplémentaires avec ces méthodes écraseront les appels précédents.

avecRègles

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

Limitez l'analyse aux seules règles spécifiées. Ne peut pas être utilisé avec AxeDevToolsWebdriverIO.withTags().

avecTags

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

Limitez l'analyse aux seules balises spécifiées. Ne peut pas être utilisé en conjonction avec AxeDevToolsWebdriverIO.withRules().

désactiverRègles

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

Définissez la liste des règles à ignorer lors de l'exécution d'une analyse.

Options axe-core

Ces options accèdent à la configuration axe-core sous-jacente. Pour plus d'informations sur ces options, consultez la documentation axe-core.

configurer

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

Définir la configuration pour axe-core. Cette valeur est transmise directement à axe.configure() [objet manquant].

options

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

The runOptions à passer directement à axe.run(). Consultez la documentation axe-core pour l'utilisation. Remplacera toutes les autres options configurées, y compris les appels à AxeDevToolsWebdriverIO.withRules() et AxeDevToolsWebdriverIO.withTags().

Service d'utilisation

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

Par défaut, le service d'utilisation est désactivé et l'URL par défaut est https://usage.deque.com.

Variables d'environnement

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

Activer le suivi

Cette méthode permet aux utilisateurs de choisir d'envoyer des données au service d'usage

.enableTracking(state: boolean): AxeDevToolsWebdriverIO

setTrackingUrl

Cette méthode permet aux utilisateurs de modifier l'endroit où les données de métriques d'usage sont envoyées.

.setTrackingUrl(url: string): AxeDevToolsWebdriverIO

setDistinctId

Cette méthode permet aux utilisateurs de modifier l'identifiant distinct stocké/utilisé

.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO