Referência da API do WebdriverIO para Axe DevTools para 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

Referência para as APIs no pacote @axe-devtools/webdriverio

Not for use with personal data

Construtor

Na configuração padrão, o único argumento necessário a ser passado para o construtor do WebdriverIO é a instância do WebdriverIO. Se você quiser usar uma versão diferente do axe-core do que a incluída originalmente ou um conjunto de regras personalizado, você pode passar essas opções no construtor.

note

Você não pode selecionar uma versão axe-core não padrão e um conjunto de regras personalizado.

AxeDevToolsWebdriverIO(options: Options)

A interface Options é um objeto que contém as seguintes propriedades:

client (obrigatório): um cliente WebdriverIO
axeSource (opcional): uma string do código-fonte do axe-core
rulesetID (opcional): um ID de conjunto de regras ('wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa', '508', 'en301549', 'rgaav4', 'ttv5')

note

Você não pode fornecer ambos axeSource e rulesetID. Os dois são mutuamente exclusivos.

Definindo a versão do axe-core

Por padrão, o @axe-devtools/webdriverio usará a última versão disponível do axe-core. Para configurar uma versão diferente do axe-core, passe a opção axeSource. Todas as versões do axe-core podem ser obtidas no npm ou através do unpkg visitando http://unpkg.com/axe-core@<version>/axe.js (substitua <version> pelo número da versão). Todas as versões do axe-core após 2.1.0 são suportadas.

Este é um exemplo de inicialização do Axe DevTools WebdriverIO com o axe-core 2.3.0 a partir de um arquivo localizado no diretório pai do arquivo de teste.

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

Método analyze

Este método executa a análise e, em última instância, retorna os resultados do escaneamento de acessibilidade.

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

Executa uma análise usando a configuração padrão no cliente fornecido. Um Promise é retornado, que resolve com o conjunto de resultados retornado pelo axe-core.

Regras Personalizadas

Para obter informações sobre como usar regras personalizadas com o Axe DevTools, leia o guia sobre geração e integração de conjunto de regras personalizadas no guia CLI.

Método analyzeUniversal

Realiza uma análise e retorna resultados no Formato Universal Axe. O método existente analyze() permanece inalterado.

analyzeUniversal(): Promise<UniversalExport>

Opções de Cadeia

Existem várias opções para definir o escopo de suas varreduras Axe DevTools. Você pode incluir ou excluir escopos CSS específicos e/ou ignorar iframes. Os métodos de cadeia (abaixo) no construtor tornam isso possível.

disableFrame

AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIO

Desabilite a injeção do axe-core em frames que correspondem ao seletor CSS fornecido. Este método pode ser chamado qualquer número de vezes.

include

AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO

Seletor para incluir na análise. Este pode ser chamado qualquer número de vezes.

exclude

AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIO

Seletor para excluir na análise. Este pode ser chamado qualquer número de vezes.

Configuração de Regras

Essas opções modificam a configuração de regras para o conjunto de regras escolhido. Estas opções sobrescrevem a configuração padrão de regras e modificarão seus resultados. Chamadas adicionais com esses métodos sobrescreverão chamadas anteriores.

withRules

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

Limita a análise apenas às regras especificadas. Não pode ser usado com AxeDevToolsWebdriverIO.withTags().

withTags

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

Limita a análise apenas às tags especificadas. Não pode ser usado com AxeDevToolsWebdriverIO.withRules().

disableRules

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

Defina a lista de regras a serem ignoradas ao executar uma análise.

Opções do axe-core

Essas opções acessam a configuração subjacente do axe-core. Para mais informações sobre essas opções, consulte o documentação do axe-core.

configurar

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

Configura a configuração do axe-core. Este valor é passado diretamente para axe.configure().

opções

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

O runOptions para passar diretamente para axe.run(). Veja o documentação do axe-core para uso. Irá substituir qualquer outra opção configurada, incluindo chamadas para AxeDevToolsWebdriverIO.withRules() e AxeDevToolsWebdriverIO.withTags().

Serviço de Uso

O serviço de uso permite que você obtenha insights sobre as tendências de uso do Axe DevTools dentro de sua organização.

Por padrão, o serviço de uso está ativado, e a URL padrão é https://usage.deque.com. Defina a variável de ambiente AXE_TRACK_USAGE para false para desativá-lo.

Variáveis de ambiente

Essas variáveis de ambiente permitem que você configure o serviço de uso e altere as propriedades dos eventos relatados.

Nome	Tipo	Pode Sobrescrever	Descrição
`AXE_DISTINCT_ID`	String	—	Um identificador UUID que permanece o mesmo para o usuário logado (a menos que seja regenerado). Em Ruby, essa variável é chamada de `DEQUE_DISTINCT_ID`.
`AXE_INCLUDE_TEST_RESULTS`	Boolean	—	Defina como `true` para incluir os resultados completos do axe-core no objeto `testResults` de cada evento (o padrão é `false`). Suportado apenas pelo CLI e pelas APIs do Node.js.
`AXE_METRICS_URL`	String	—	A URL do endpoint de uso REST (o padrão é `https://usage.deque.com`)
`AXE_TRACK_USAGE`	Boolean	—	Defina como `false` para desativar o relatório do serviço de uso. O relatório está ativado por padrão.
`AXE_APPLICATION`	String	false	O aplicativo que foi utilizado para verificar erros de acessibilidade
`AXE_DEV_INSTANCE`	Boolean	true	Indica se este evento é resultante das ações de um desenvolvedor de software. Útil para marcar e posteriormente remover eventos registrados durante o desenvolvimento ou teste.
`AXE_DEPARTMENT`	String	true	O departamento do usuário dentro da organização
`AXE_KEYCLOAK_ID`	String	false	O ID Keycloak do usuário
`AXE_LOGGED_IN`	Boolean	false	Registra se o usuário está logado na aplicação em teste
`AXE_ORGANIZATION`	String	true	A organização do usuário. Para que seu uso apareça nos Relatórios Axe, defina isso para o ID da sua organização (entre em contato com a Deque para obtê-lo).
`AXE_SESSION_ID`	String	false	Um UUID identificando a sessão do usuário
`AXE_USER_ID`	String	false	A identidade de um usuário específico, como um endereço de e-mail, nome ou ID de login. Os Relatórios Axe contam usuários únicos a partir deste valor.
`AXE_USER_JOB_ROLE`	String	false	O cargo do usuário
`AXE_USER_STATUS`	String	false	Informações de status que você deseja associar ao usuário

habilitarRastreamento

Este método permite aos usuários optar por enviar ou não dados para o serviço de uso. O envio está ativado por padrão.

.enableTracking(state: boolean): AxeDevToolsWebdriverIO

definirUrlDeRastreamento

Este método permite que os usuários alterem para onde os dados de métricas de uso estão sendo enviados

.setTrackingUrl(url: string): AxeDevToolsWebdriverIO

definirIdDistinto

Este método permite que os usuários alterem o id distinto que está sendo armazenado/usado

.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO