Référence de l'API C#

Classes C# d'axe DevTools

Cette page documente les classes qui composent axe DevTools C#

class Deque.AxeDevtools.Selenium.AxeSelenium

L'interface à axe. Contient des configurations pour modifier la façon dont axe fonctionne ainsi que la possibilité d'exécuter axe.

AxeSelenium(OpenQA.Selenium.Remote.RemoteWebDriver, ReportConfiguration?, chaîne)

Créez un nouvel objet AxeSelenium pour une page avec une configuration spécifique.

ReportResultsAnalyser()

Exécutez axe sur la page.

Renvoie : Le rapport de l'exécution de axe-core sur la page.

var report = new AxeSelenium(driver).Analyze();

AxeSelenium Configurer(Spec)

Configurer axe Fait via axe.configure

Renvoie : Cet objet pour le chaînage.

var spec = new Spec.Spec {
    Checks = new Spec.Check[] {
        new Spec.Check() {
            Id = "dylang",
            Options = (object) new string[] { "dylan" },
            Evaluate = @"function (node, options) {
              var lang = (node.getAttribute('lang') || '').trim().toLowerCase();
              var xmlLang = (node.getAttribute('xml:lang') || '').trim().toLowerCase();
              var invalid = [];
              (options || []).forEach(function(cc) {
                cc = cc.toLowerCase();
                if (lang && (lang === cc || lang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  lang = null;
                }
                if (xmlLang && (xmlLang === cc || xmlLang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  xmlLang = null;
                }
              });
              if (xmlLang) {
                invalid.push('xml:lang='' + xmlLang + ''');
              }
              if (lang) {
                invalid.push('lang='' + lang + ''');
              }
              if (invalid.length) {
                this.data(invalid);
                return true;
              }
              return false;
            }"
        }
    },
    Rules = new Spec.Rule[] {
        new Spec.Rule() {
            Id = "dylang",
            Selector = "html",
            Tags = new string[] { "wcag2aa" },
            All = new string[0],
            Any = new string[0],
            None = new string[] { "dylang" }
        }
    }
};
var report = new AxeSelenium(driver)
  .Configure(spec)
  .Analyze()

AxeSeleniumDisablingRules(string[])

Désactiver certaines règles lors de l'exécution d'axe.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .DisablingRules("html-has-lang", "label")
  .Analyze()

AxeSeleniumExcluant(string[])

Spécifiez la partie de la page à exclure lors de l'exécution d'axe.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .Excluding(".third-party-ad", ".iframe1")
  .Analyze()

AxeSeleniumIncluant(string[])

Spécifiez la partie de la page sur laquelle exécuter axe.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .Including(".sidebar", ".some-class")
  .Analyze()

AxeSelenium RunOptions(RunOptions)

Spécifiez RunOptions à transmettre à axe lors de l'appel axe.run.

Renvoie : Cet objet pour le chaînage.

var options = new RunOptions.RunOptions {
  IFrames = false,
  RunOnly = RunOptions.RunOnly.Tags(RunOptions.TagType.Wcag2a)
};
var report = new AxeSelenium(driver)
  .RunOptions(options)
  .Analyze()

AxeSeleniumWithConfigFile(string)

Définissez où trouver un fichier de configuration. Le chemin par défaut est config/axe-ruleset.json ou $AXE_RULESET_PATH.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .WithConfigFile("path/to/file.json")
  .Analyze();

AxeSeleniumWithRules(string[])

Spécifiez les règles (par identifiant) à utiliser lors de l'exécution d'axe.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .WithRules("document-title", "label")
  .WithRules("html-has-lang")
  .Analyze()

AxeSeleniumWithRuleset(string, bool)

Utilisez un ensemble de règles spécifiques (c'est-à-dire wcag2.1, 508).

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .WithRuleset("508", true)
  .Analyze()

AxeSelenium WithTags(TagType[])

Spécifiez les règles (par étiquette) à utiliser lors de l'exécution d'axe.

Renvoie : Cet objet pour le chaînage.

var report = new AxeSelenium(driver)
  .WithTags(RunTagType.BestPractice)
  .Analyze()

Variables d'environnement

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

AxeSeleniumEnableTracking(bool)

Acceptez ou refusez l'envoi de données au service d'utilisation.

Renvoie : Cet objet pour le chaînage.

AxeSeleniumSetTrackingUrl(string)

Définissez où les données des mesures d’utilisation sont envoyées. Par défaut à https://usage.deque.com

Renvoie : Cet objet pour le chaînage.

AxeSeleniumSetDistinctId(string)

Définissez un identifiant distinct utilisé lors de l’envoi de métriques d’utilisation.

Renvoie : Cet objet pour le chaînage.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Configure les informations spécifiques au rapport, telles que le nom de la suite de tests ou les informations de l'agent utilisateur

static ReportConfigurationGetDefault()

Récupère la configuration par défaut actuelle. Notez que la valeur par défaut peut être modifiée.

Renvoie : la valeur par défaut actuelle.

static void ResetDefault()

Réinitialise la valeur par défaut à son état initial.

void SetAsDefault()

Définit cet objet comme objet par défaut.

ReportConfiguration.GetDefault()
  .TestSuiteName("my-tests")
  .UIState("home-page")
  .SetAsDefault();

ReportConfigurationTestMachine(chaîne)

Définit la machine sur laquelle ces tests ont été exécutés.

Renvoie : Cet objet pour le chaînage.

ReportConfigurationTestSuiteName(chaîne)

Définit le nom de la suite de tests.

Renvoie : Cet objet pour le chaînage.

ReportConfigurationUIState(chaîne)

Spécifiez l'état de l'interface utilisateur pour cet ensemble de tests. Utilisé comme identifiant.

Renvoie : Cet objet pour le chaînage.

ReportConfigurationUserAgent(chaîne)

Définissez l'agent utilisateur utilisé lors des tests.

Renvoie : Cet objet pour le chaînage.

class Deque.AxeDevtools.Selenium.Results.Check

Le résultat de l'exécution d'un test axe.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Un nœud HTML qui a été vérifié par une règle.

class Deque.AxeDevtools.Selenium.Results.Node

Spécifie un nœud HTML spécifique.

class Deque.AxeDevtools.Selenium.Results.Platform

La plate-forme sur laquelle un test a été exécuté.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Résultats d'un test compatibles avec le format du générateur de rapport.

var axe = new AxeSelenium(driver, ReportConfiguration.GetDefault().UIState("UIState"));
var res = axe.Analyze();
File.WriteAllText(reportPath, JsonConvert.SerializeObject(res));

class Deque.AxeDevtools.Selenium.Results.Rule

Résultat pour une seule règle.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Informations sur le moteur axe-core sur lequel le test a été exécuté.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Informations sur l'environnement dans lequel le test a été réalisé.

class Deque.AxeDevtools.Selenium.Results.TestResults

Résultats renvoyés en exécutant axe sur la page.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Nom de l'exécuteur de tests.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Informations sur ce qui est testé.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Précisez quel élément doit et lequel ne doit pas être testé.

void Excluding(string[])

Ajoutez un ensemble de sélecteurs pour les éléments qui ne doivent pas être testés.

void Including(string[])

Ajoutez un ensemble de sélecteurs pour les éléments qui doivent être testés.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Réussites
• Infractions
• Incomplet
• Inapplicable

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Active ou désactive une règle.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Limiter les règles exécutées, en fonction des noms ou des balises.

static RunOnlyRègles(string[])

Construisez un limiteur pour les règles basées sur les identifiants.

Renvoie : L'objet RunOnly .

Statique RunOnly Tags(TagType[])

Construire un limiteur pour les règles basées sur des balises.

Renvoie : L'objet RunOnly .

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Règle
• Règles
• Tag
• Balises

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Une configuration flexible pour le fonctionnement de axe.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Section 508
• TTv5
• EN301549
• Meilleures pratiques

class Deque.AxeDevtools.Selenium.Spec.Check

Utilisé pour ajouter des vérifications à la liste des vérifications utilisées par les règles, ou pour remplacer les propriétés des vérifications existantes.

class Deque.AxeDevtools.Selenium.Spec.Rule

Utilisé pour ajouter des règles à l'ensemble de règles existant ou pour remplacer les propriétés des règles existantes.

class Deque.AxeDevtools.Selenium.Spec.Spec

Configure le format des données utilisées par axe. Cela peut être utilisé pour ajouter de nouvelles règles, qui doivent être enregistrées auprès de la bibliothèque pour être exécutées.