Referência de API C#

Classes Axe DevTools em C#

Esta página documenta as classes que compõem o Axe DevTools em C#

class Deque.AxeDevtools.Selenium.AxeSelenium

A interface para a análise de acessibilidade. Contém configurações que alteram como a análise é executada, além da capacidade de executá-la.

AxeSelenium(OpenQA.Selenium.Remote.RemoteWebDriver, ConfiguraçãoDoRelatório?, string)

Cria um novo objeto AxeSelenium para uma página com configuração específica.

ResultadosRelatórioAnalisar()

Execute a análise de acessibilidade na página.

Retorna: O relatório da execução do axe-core na página.

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

AxeSelenium Configurar(Especificação)

Configura o axe. Feito via axe.configure

Retorna: Este objeto para encadeamento.

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()

AxeSeleniumDesativandoRegras(string[])

Desative algumas regras ao executar a análise.

Retorna: Este objeto para encadeamento.

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

AxeSeleniumExcluindo(string)

Especifique a parte da página a ser excluída da análise. Para excluir várias partes não relacionadas da página, chame Excluding uma vez para cada uma.

Retorna: Este objeto para encadeamento.

var report = new AxeSelenium(driver)
  .Excluding(".cookie-banner")
  .Excluding(".ad-slot")
  .Analyze()

AxeSeleniumExcluindo(params string[])

Especifique um elemento dentro de um ou mais iframes aninhados para excluir. Todos os seletores, exceto o último, correspondem a um nível de aninhamento de iframe; o último corresponde ao elemento a ser excluído dentro do iframe mais interno.

Como o parâmetro é declarado params, Excluding(".iframe1", ".third-party-ad") e Excluding(new[] { ".iframe1", ".third-party-ad" }) são a mesma chamada. De qualquer forma, os seletores formam um único seletor de iframe, não exclusões separadas. Para excluir várias partes não relacionadas da página, chame Excluding(string) uma vez para cada uma.

Retorna: Este objeto para encadeamento.

// Exclude .third-party-ad inside the iframe matched by .iframe1
var report = new AxeSelenium(driver)
  .Excluding(".iframe1", ".third-party-ad")
  .Analyze()

AxeSeleniumExcluindo(string[][])

Especifique um elemento dentro de uma ou mais árvores DOM de sombra aninhadas para excluir. Passe um array interno por chamada. Dentro desse array, todos os seletores, exceto o último, correspondem a um host de sombra, e o último corresponde ao elemento a ser excluído dentro da raiz de sombra mais interna.

Retorna: Este objeto para encadeamento.

// Exclude #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Excluding(selector)
  .Analyze()

AxeSelenium Excluindo(FromFrames)

Especifique um elemento dentro de um ou mais iframes aninhados para excluir, usando um seletor FromFrames explícito.

Retorna: Este objeto para encadeamento.

// Exclude the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Excluding(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Excluindo(FromShadowDom)

Especifique um elemento dentro de uma ou mais árvores DOM de sombra aninhadas para excluir, usando um seletor FromShadowDom explícito.

Como o axe-core verifica os elementos contra a árvore DOM achatada, selecionar um nó DOM de sombra também seleciona quaisquer descendentes inseridos através de um elemento <slot>.

Retorna: Este objeto para encadeamento.

// Exclude the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Excluding(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumExcluindo(params object[])

Especifique um seletor que combine seletores CSS simples com objetos FromFrames ou FromShadowDom, para casos que as outras sobrecargas não conseguem expressar.

Esta sobrecarga é selecionada apenas quando a chamada passa mais de um argumento, ou um único argumento que não seja de um dos tipos acima. Passar um único FromFrames ou FromShadowDom seleciona Excluding(FromFrames) ou Excluding(FromShadowDom) em vez disso.

Para acessar um iframe que vive dentro de uma raiz de sombra, o seletor FromShadowDom deve estar aninhado dentro do seletor FromFrames; o inverso causa um erro.

Retorna: Este objeto para encadeamento.

// Exclude .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Excluding("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSeleniumIncluindo(string)

Especifique a parte da página a ser analisada. Para analisar várias partes não relacionadas da página, chame Including uma vez para cada uma.

Retorna: Este objeto para encadeamento.

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

AxeSeleniumIncluindo(params string[])

Especifique um elemento dentro de um ou mais iframes aninhados para testar. Todos os seletores, exceto o último, correspondem a um nível de aninhamento de iframe; o último corresponde ao elemento a ser testado dentro do iframe mais interno.

Como o parâmetro é declarado params, Including(".sidebar-frame", ".some-class") e Including(new[] { ".sidebar-frame", ".some-class" }) são a mesma chamada. De qualquer forma, os seletores formam um único seletor de iframe, não inclusões separadas. Para testar várias partes não relacionadas da página, chame Including(string) uma vez para cada uma.

Retorna: Este objeto para encadeamento.

// Test .some-class inside the iframe matched by .sidebar-frame
var report = new AxeSelenium(driver)
  .Including(".sidebar-frame", ".some-class")
  .Analyze()

AxeSeleniumIncluindo(string[][])

Especifique um elemento dentro de uma ou mais árvores DOM de sombra aninhadas para testar. Passe um array interno por chamada. Dentro desse array, todos os seletores, exceto o último, correspondem a um host de sombra, e o último corresponde ao elemento a ser testado dentro da raiz de sombra mais interna.

Retorna: Este objeto para encadeamento.

// Test #shadow-button inside the shadow root attached to #shadow-host
var selector = new string[][] {
  new string[] { "#shadow-host", "#shadow-button" }
};
var report = new AxeSelenium(driver)
  .Including(selector)
  .Analyze()

AxeSelenium Incluindo(FromFrames)

Especifique um elemento dentro de um ou mais iframes aninhados para testar, usando um seletor FromFrames explícito.

Retorna: Este objeto para encadeamento.

// Test the form inside the #payment-frame iframe
var report = new AxeSelenium(driver)
  .Including(new FromFrames("#payment-frame", "form"))
  .Analyze()

AxeSelenium Incluindo(FromShadowDom)

Especifique um elemento dentro de uma ou mais árvores de shadow DOM aninhadas para testar, usando um seletor FromShadowDom explícito.

Porque axe-core corresponde aos elementos contra a árvore DOM achatada, selecionar um nó de shadow DOM também seleciona quaisquer descendentes inseridos por um elemento <slot>.

Retorna: Este objeto para encadeamento.

// Test the #search form inside the shadow root attached to .app-header
var report = new AxeSelenium(driver)
  .Including(new FromShadowDom(".app-header", "form#search"))
  .Analyze()

AxeSeleniumIncluindo(params object[])

Especifique um seletor que misture seletores CSS simples com objetos FromFrames ou FromShadowDom, para casos que as outras sobrecargas não conseguem expressar.

Essa sobrecarga é selecionada apenas quando a chamada passa mais de um argumento, ou um único argumento que não seja um dos tipos acima. Passar um único FromFrames ou FromShadowDom seleciona Including(FromFrames) ou Including(FromShadowDom) em vez disso.

Para alcançar um iframe que está dentro de uma raiz de shadow, o seletor FromShadowDom deve estar aninhado dentro do seletor FromFrames; o inverso causa um erro.

Retorna: Este objeto para encadeamento.

// Test .target inside the shadow root attached to #host, inside the #frame iframe
var report = new AxeSelenium(driver)
  .Including("#frame", new FromShadowDom("#host", ".target"))
  .Analyze()

AxeSelenium RunOptions(RunOptions)

Especifique RunOptions para passar ao chamar axe.run.

Retorna: Este objeto para encadeamento.

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

AxeSeleniumWithConfigFile(string)

Determine onde encontrar um arquivo de configuração. O caminho padrão é config/axe-ruleset.json ou $AXE_RULESET_PATH.

Retorna: Este objeto para encadeamento.

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

AxeSeleniumWithRules(string[])

Especifique regras (por id) para usar ao executar a análise.

Retorna: Este objeto para encadeamento.

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

AxeSeleniumWithRuleset(string, bool)

Use um conjunto de regras específico (isto é, wcag2.1, 508).

Retorna: Este objeto para encadeamento.

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

AxeSelenium ComTags(TagType[])

Especifique regras (por tag) para usar ao executar a análise.

Retorna: Este objeto para encadeamento.

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

Variáveis de ambiente

Essas variáveis de ambiente permitem configurar o serviço de uso e alterar as propriedades dos eventos relatados.

AxeSeleniumAtivarRastreamento(bool)

Escolha participar ou não do envio de dados para o serviço de uso. O envio está ativado por padrão.

Retorna: Este objeto para encadeamento.

AxeSeleniumDefinirUrlRastreamento(string)

Defina para onde os dados de métricas de uso são enviados. Padrão para https://usage.deque.com

Retorna: Este objeto para encadeamento.

AxeSeleniumDefinirIdDistinto(string)

Defina o id distinto usado ao enviar métricas de uso.

Retorna: Este objeto para encadeamento.

class Deque.AxeDevtools.Selenium.ReportConfiguration

Configura informações específicas do relatório, como nome da suíte de testes ou informações do agente do usuário

estático ConfiguraçãoDoRelatórioGetDefault()

Obtém a configuração padrão atual. Note que o padrão pode ser alterado.

Retorna: A configuração padrão atual.

estático void ResetDefault()

Redefine o padrão para seu estado inicial.

void SetAsDefault()

Define este objeto como padrão.

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

ConfiguraçãoDoRelatórioTestMachine(string)

Define a máquina em que esses testes foram executados.

Retorna: Este objeto para encadeamento.

ConfiguraçãoDoRelatórioTestSuiteName(string)

Define o nome do conjunto de testes.

Retorna: Este objeto para encadeamento.

ConfiguraçãoDoRelatórioUIState(string)

Especifica o estado da interface de usuário para este conjunto de testes. Usado como ID.

Retorna: Este objeto para encadeamento.

ConfiguraçãoDoRelatórioUserAgent(string)

Define o agente de usuário utilizado durante o teste.

Retorna: Este objeto para encadeamento.

class Deque.AxeDevtools.Selenium.Results.Check

O resultado de executar uma verificação.

class Deque.AxeDevtools.Selenium.Results.CheckedNode

Um nó HTML que foi verificado por uma regra.

class Deque.AxeDevtools.Results.FromFrames

Um seletor que mira em um elemento dentro de um ou mais iframes aninhados. Passe-o para Including(FromFrames) ou Excluding(FromFrames).

FromFrames(params object[])

var report = new AxeSelenium(driver)
  .Including(new FromFrames("iframe#outer", "iframe#inner", "form"))
  .Analyze()

class Deque.AxeDevtools.Results.FromShadowDom

Um seletor que mira em um elemento dentro de uma ou mais árvores de shadow DOM aninhadas. Passe-o para Including(FromShadowDom) ou Excluding(FromShadowDom).

FromShadowDom(params string[])

var report = new AxeSelenium(driver)
  .Including(new FromShadowDom("app-root", ".header", "#search"))
  .Analyze()

class Deque.AxeDevtools.Selenium.Results.Node

Especifica um nó HTML específico.

class Deque.AxeDevtools.Selenium.Results.Platform

A plataforma na qual um teste foi executado.

class Deque.AxeDevtools.Selenium.Results.ReportResults

Resultados de um teste que são compatíveis com o formato do repórter.

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

Resultado para uma única regra.

class Deque.AxeDevtools.Selenium.Results.TestEngine

Informações sobre o mecanismo axe-core em que o teste foi executado.

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

Informações sobre o ambiente em que o teste foi realizado.

class Deque.AxeDevtools.Selenium.Results.TestResults

Resultados retornados ao executar a análise na página.

class Deque.AxeDevtools.Selenium.Results.TestRunner

Nome do executor de testes.

class Deque.AxeDevtools.Selenium.Results.TestSubject

Informações sobre o que está sendo testado.

class Deque.AxeDevtools.Selenium.RunOptions.Context

Especifique qual elemento deve e qual não deve ser testado.

void Excluding(string[])

Adicione um conjunto de seletores para elementos que não devem ser testados.

void Including(string[])

Adicione um conjunto de seletores para elementos que devem ser testados.

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• Passa
• Violações
• Incompleto
• Inaplicável

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

Ativa ou desativa uma regra.

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

Limitar quais regras são executadas, com base em nomes ou tags.

static ExecutarApenasRules(string[])

Construa um limitador para regras baseado em IDs.

Retorna: O objeto RunOnly.

static ExecutarApenas Tags(TagType[])

Construa um limitador para regras baseadas em tags.

Retorna: O objeto RunOnly.

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• Regra
• Regras
• Tag
• Tags

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

Uma configuração flexível para como a análise opera.

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Seção508
• TTv5
• EN301549
• RGAAv4
• MelhoresPráticas

class Deque.AxeDevtools.Selenium.Spec.Check

Usado para adicionar verificações à lista de verificações usadas por regras, ou para substituir as propriedades de verificações existentes.

class Deque.AxeDevtools.Selenium.Spec.Rule

Usado para adicionar regras ao conjunto de regras existentes, ou para substituir as propriedades de regras existentes.

class Deque.AxeDevtools.Selenium.Spec.Spec

Configura o formato dos dados da regra. Isso pode ser usado para adicionar novas regras, que precisam ser registradas na biblioteca para execução.