Referencia de API de WebdriverIO para axe DevTools for 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

Referencia para las API en el paquete @axe-devtools/webdriverio

Not for use with personal data

Constructor

En la configuración estándar, el único argumento que debe pasarse al constructor de WebdriverIO es la instancia de WebdriverIO. Si desea utilizar una versión de axe-core diferente a la incluida originalmente o un conjunto de reglas personalizado, puede pasar estas opciones al constructor.

note

No puedes seleccionar una versión de axe-core no estándar ** ni ** un conjunto de reglas personalizado.

AxeDevToolsWebdriverIO(options: Options)

La Options interfaz es un objeto que contiene las siguientes propiedades:

client (obligatorio): Un cliente WebdriverIO
axeSource (opcional): una cadena de código fuente de axe-core
rulesetID (opcional): un ID de conjunto de reglas ('wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa', '508', 'en301549', 'ttv5')

note

No puedes proporcionar ambos axeSource y rulesetID. Ambos son mutuamente excluyentes.

Definición de la versión de axe-core

De forma predeterminada, @axe-devtools/webdriverio utilizará la última versión disponible de axe-core. Para configurar una versión diferente de axe-core, introduzca la opción axeSource . Todas las versiones de axe-core se pueden obtener desde npm o mediante unpkg visitando http://unpkg.com/axe-core@<version>/axe.js (reemplace <version> Con el número de versión). Se admiten todas las versiones de axe-core posteriores a 2.1.0.

Este es un ejemplo de inicialización de axe DevTools WebdriverIO con axe-core 2.3.0 desde un archivo ubicado en el directorio principal del archivo de prueba.

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

Método analizar

Este método ejecuta el análisis y finalmente devuelve los resultados del escaneo de accesibilidad.

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

Ejecute un análisis utilizando la configuración predeterminada en el cliente determinado. Se devuelve A Promise , que se resuelve con el conjunto de resultados devuelto por axe-core.

Reglas personalizadas

Para obtener información sobre el uso de reglas personalizadas con axe DevTools, lea la guía sobre generación e integración de conjuntos de reglas personalizados en la guía CLI.

Opciones de secuencia

Existen varias opciones para delimitar el alcance de los escaneos de axe DevTools. Puede incluir o excluir ámbitos CSS específicos y/o ignorar iframes. Los métodos de cadena (abajo) del constructor hacen esto posible.

disableFrame

AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIO

Deshabilitar la inyección de axe-core en los marcos que coincidan con el selector CSS dado. Este método puede llamarse cualquier cantidad de veces.

incluir

AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO

Selector a incluir en el análisis. Este método se puede llamar cualquier cantidad de veces.

excluir

AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIO

Selector para excluir en el análisis. Este método se puede llamar cualquier cantidad de veces.

Configuración de reglas

Estas opciones modifican la configuración de reglas para el ruleset elegido. Estas opciones sobrescriben la configuración de regla estándar y modificarán sus resultados. Las llamadas adicionales con estos métodos sobrescribirán las llamadas anteriores.

withRules

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

Limite el análisis únicamente a las reglas especificadas. No se puede utilizar con AxeDevToolsWebdriverIO.withTags().

withTags

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

Limitar el análisis únicamente a las etiquetas especificadas. No se puede utilizar con AxeDevToolsWebdriverIO.withRules().

disableRules

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

Establezca la lista de reglas que se deben omitir al ejecutar un análisis.

Opciones de axe-core

Estas opciones acceden a la configuración subyacente de axe-core. Para obtener más información sobre estas opciones, consulte la documentación de axe-core.

configurar

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

Establecer la configuración para axe-core. Este valor se pasa directamente a axe.configure().

Opciones

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

Para pasar directamente a runOptions . axe.run() Consulte la documentación de axe-core para su uso. Anulará cualquier otra opción configurada, incluidas las llamadas a AxeDevToolsWebdriverIO.withRules() y AxeDevToolsWebdriverIO.withTags().

Servicio de uso

El servicio de uso le permite obtener información sobre las tendencias de uso de axe DevTools dentro de su organización.

De forma predeterminada, el servicio de uso está deshabilitado y la URL predeterminada es https://usage.deque.com.

Variables de entorno

Este método permite a los usuarios cambiar valores específicos del servicio de utilización a través de variables de entorno.

Variable ambiental	Tipo
AXE_IS_LOGGED_IN	Booleano
AXE_KEYCLOAK_ID	Cadena
AXE_USER_ID	Cadena
AXE_SESSION_ID	Cadena
AXE_USER_STATUS	Cadena
AXE_USER_JOB_ROLE	Cadena
AXE_DISTINCT_ID	Cadena
AXE_IS_DEV_INSTANCE	Booleano
AXE_ORGANIZACIÓN	Cadena
APLICACIÓN AXE	Cadena
AXE_METRICS_URL	Cadena
AXE_TRACK_USAGE	Booleano

Habilitar seguimiento

Este método permite a los usuarios optar por enviar datos al servicio de uso.

.enableTracking(state: boolean): AxeDevToolsWebdriverIO

setTrackingUrl

Este método permite a los usuarios cambiar a dónde se envían los datos de las métricas de uso.

.setTrackingUrl(url: string): AxeDevToolsWebdriverIO

setDistinctId

Este método permite a los usuarios cambiar la identificación distinta que se almacena/usa.

.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO