Referencia de API de Cypress 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/cypress

Not for use with personal data

Cypress Chainable Commands (analyze)

`cy.axeAnalyze()`

Este comando encadenable inyecta axe en todas las páginas e iframes y luego se ejecuta axe en la página.

Parámetro	Tipo	Valor predeterminado	Descripción
Contexto (opcional)	axe.ElementContext	No definido	Define el alcance del análisis: la parte del DOM que desea analizar. Normalmente será el documento o un selector específico, como el nombre de la clase, el ID, el selector, etc.
Opciones (opcional)	axe.RunOptions	No definido	Conjunto de opciones que se pasan a reglas o comprobaciones, modificándolas temporalmente. Esto contrasta con `axe.configure`[insert term], que es más permanente.
Registro (opcional)	Booleano	false	Devuelve la salida a stdout con la cantidad de elementos que no son accesibles y los impactos de las violaciones en forma de tabla.

`cy.isAxeClean()`

Este comando encadenable es una afirmación de que la página no tiene violaciones de accesibilidad.

Parámetros:

Parámetro	Tipo	Valor predeterminado	Descripción
Contexto (opcional)	axe.ElementContext	No definido	Define el alcance del análisis: la parte del DOM que desea analizar. Normalmente será el documento o un selector específico, como el nombre de la clase, el ID, el selector, etc.
Opciones (opcional)	axe.RunOptions	No definido	Conjunto de opciones que se pasan a reglas o comprobaciones, modificándolas temporalmente. Esto contrasta con `axe.configure`[insert term], que es más permanente.

Cypress Chainable Commands (configuration)

Integra axe DevTools for Web con Cypress usando comandos encadenables personalizados de Cypress para configurar los resultados analizados.

`cy.setAxeSource()`

Este comando encadenable establece la versión de axe.

Parámetro	Tipo	Valor predeterminado	Descripción
Ruta del archivo (obligatorio)	Cadena	nulo	Ruta relativa a la raíz del proyecto que debe incluir `axe.source` o la versión minificada de axe.

`cy.setAxeCustom()`

Este comando encadenable permite el uso de conjuntos de reglas personalizados.

axe DevTools for Web Cypress leerá implícitamente también axe-ruleset.json cuando se coloque en el nivel raíz del proyecto o también usará archivos de conjuntos de reglas personalizados cuando la variable de entorno AXE_RULESET_PATH esté configurada.

Parámetro	Tipo	Valor predeterminado	Descripción
Ruta del archivo (obligatorio)	Cadena	nulo	Ruta relativa a la raíz del proyecto que debe incluir comprobaciones y reglas

`cy.setAxeRuleset()`

Este comando encadenable permite a los usuarios ejecutar reglas por etiquetas, de forma similar a la configuración axe.run().

Parámetro	Tipo	Valor predeterminado	Descripción
Conjunto de reglas (obligatorio)	'508', 'en301549', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	'wcag2.1'	Arreglo de etiquetas a las que se asigna esta regla.

`cy.setAxeReportName()`

Este comando encadenable permite a los usuarios establecer el nombre del archivo de informe.

Parámetro	Tipo	Valor predeterminado	Descripción
reportName (requerido)	Cadena	@axe-devtools-cypress	Nombre del archivo del informe.

`cy.getAxeResults()`

Este comando encadenable permite a los usuarios utilizar los resultados después de la ejecución cy.axeAnalyze().

Las respuestas de getAxeResults() devuelve la estructura de los datos axe.AxeResults.

Ejemplo:

after(() => {
  cy.axeAnalyze();
  cy.getAxeResults().then(data => {
    cy.writeFile('./results.json', data)
  })
})

Servicio de uso

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

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

`cy.task('enableTracking', <boolean>)`

Esta tarea de Cypress permite a los usuarios optar por enviar datos al servicio de uso.

`cy.task('setTrackingUrl', <string>)`

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

`cy.task('setDistinctId', <string>)`

Esta tarea de Cypress permite a los usuarios cambiar la identificación distinta que se almacena o utiliza.

Próximos pasos

Si tiene algún problema al instalar axe DevTools for Web, comuníquese directamente con su representante de Deque, pregúntenos a través de nuestra mesa de soporte o envíenos un correo electrónico. Estaremos encantados de ayudarle a ponerse en marcha.