Importación e Inicialización para WebdriverIO

Una vez que hayas instalado Axe DevTools para Web, necesitas importarlo a tu configuración de pruebas e inicializar el paquete.

Requisitos previos

Para importar e inicializar Axe DevTools para Web, primero debe estar instalado. Si aún no lo has hecho, lee la guía sobre cómo instalarlo desde un paquete, desde tu repositorio de artefactos o desde Agora de Deque. También necesitas tener WebdriverIO descargado y configurado.

Importación e Inicialización

Importe tanto Axe DevTools para Web como WebdriverIO. La sintaxis depende del lenguaje y el sistema de módulos que use su proyecto. Elija el que coincida con su proyecto:

JavaScript con módulos CommonJS

Este es el predeterminado para un proyecto Node.js sin "type": "module" en su package.json.

const { AxeDevToolsWebdriverIO } = require('@axe-devtools/webdriverio');
const webdriverio = require('webdriverio');

JavaScript con módulos ES

Use esta sintaxis en un proyecto con "type": "module" en su package.json, o en archivos .mjs.

import { AxeDevToolsWebdriverIO } from '@axe-devtools/webdriverio';
import { remote } from 'webdriverio';

TypeScript

TypeScript usa la misma sintaxis de import que los módulos ES. @axe-devtools/webdriverio incluye sus propias declaraciones de tipos, por lo que no hay un paquete de @types/ separado para instalar. Los resultados del escaneo tienen el tipo AxeResults, que exporta axe-core:

import { AxeDevToolsWebdriverIO } from '@axe-devtools/webdriverio';
import { remote } from 'webdriverio';
import type { AxeResults } from 'axe-core';

Inicializando el Cliente

En este punto, podrá inicializar su webdriver dentro de su función de prueba. En JavaScript:

const client = await webdriverio.remote({
  capabilities: {
    browserName: 'chrome'
  }
});

En TypeScript, el cliente es un WebdriverIO.Browser, que es el tipo que AxeDevToolsWebdriverIO espera:

const client: WebdriverIO.Browser = await remote({
  capabilities: {
    browserName: 'chrome'
  }
});

Luego, puede inicializar Axe DevTools para Web con el cliente webdriver. Esta instrucción es la misma en ambos lenguajes:

const axeDevTools = new AxeDevToolsWebdriverIO({ client });

Próximos Pasos

Una vez que hayas instalado, importado e inicializado Axe DevTools para Web y su driver, estás listo para avanzar a escanear accesibilidad y escribir pruebas de accesibilidad. Cada escaneo con Axe DevTools para Web requiere una nueva instancia, así que para configurar y ejecutar tus escaneos consulta la guía sobre escribir pruebas.

Solución de Problemas

Si tienes problemas con la importación o inicialización de Axe DevTools para Web, contacta a tu representante de Deque directamente, comunícate con nosotros a través de nuestro soporte técnico o envíanos un correo electrónico. Estaremos encantados de ayudarte.