Uso de configuraciones globales
Este artículo describe cómo funciona la configuración global de axe Configuration con axe Developer Hub
Descripción general de las configuraciones globales
El panel Global de Configuración de axe proporciona una forma centralizada de administrar y controlar las configuraciones de pruebas de accesibilidad en toda su organización. Esta poderosa característica permite a los administradores empresariales establecer estándares de pruebas consistentes y al mismo tiempo brinda a los equipos y desarrolladores individuales la flexibilidad que necesitan para trabajar de manera eficaz.
¿Qué son las configuraciones globales?
Las configuraciones globales (la pestaña Global de Configuración de axe) son un conjunto de controles que determinan cómo funciona axe Developer Hub durante las pruebas de accesibilidad. Estas configuraciones incluyen:
- Contra qué estándares de accesibilidad se deben realizar las pruebas (como WCAG 2.1 AA o EN 301 549)
- Si se deben incluir comprobaciones de mejores prácticas
- Si habilitar reglas experimentales
- ¿Qué versión de axe-core usar para realizar pruebas?
Estas configuraciones se pueden gestionar tanto a nivel de empresa como de usuario individual, creando un entorno de pruebas flexible pero controlado.
¿Por qué utilizar configuraciones globales?
Las configuraciones globales resuelven varios desafíos comunes en las pruebas de accesibilidad empresarial:
- Coherencia: garantizar que todos los equipos realicen pruebas con los mismos estándares de accesibilidad
- Cumplimiento: Aplique requisitos de pruebas específicos en toda su organización
- Flexibilidad: Permitir que los equipos personalicen su enfoque de pruebas dentro de los parámetros aprobados
- Control de versiones: Administre qué versiones de axe-core se pueden usar en los proyectos
- Garantía de calidad: Mantener los estándares de prueba y, al mismo tiempo, habilitar optimizaciones específicas del equipo.
Cómo funcionan las configuraciones globales
Administradores
Los administradores establecen valores predeterminados para toda la organización y definen qué configuraciones pueden modificar los usuarios mediante la opción configurationOverrides
. Estas configuraciones establecen la base para las pruebas de axe Developer Hub dentro de la organización. Estas configuraciones se cambian en el panel Global de axe Configuration.
Algunas configuraciones del panel Global actualmente no se aplican a axe Developer Hub. Estas configuraciones incluyen:
- Predeterminado necesita revisión
- Capturas de pantalla de problemas compartidos predeterminados
- Aprendizaje automático predeterminado
- Servicio de uso
Usuarios
En lugar de utilizar el panel Global , los usuarios individuales personalizan su configuración de pruebas cambiando o agregando la opción configurationOverrides
en su código de configuración de pruebas. La opción interactúa con las configuraciones en el panel configurationOverrides
Global , tal como se define en la tabla en [Escenarios comunes de configuración global y anulación de configuración] .(#common-global-configuration-and-configuration-override-scenarios)
La referencia de API incluye más información sobre configurationOverrides
y sus propiedades.
Escenarios comunes de configuración global y anulación de configuración
Cuando se ejecuta una prueba, axe Developer Hub fusiona las configuraciones empresariales y de usuario para crear la configuración de prueba final. Esto garantiza que todas las personalizaciones permanezcan dentro de los parámetros aprobados y al mismo tiempo brinda a los usuarios la flexibilidad necesaria.
La siguiente tabla ilustra escenarios comunes que encontrará al trabajar con configuraciones globales. Cada escenario muestra cómo las configuraciones empresariales interactúan con la configuración de su proyecto.
Escenario | Lo que quiere hacer | Configuración global | Su código de configuración | Resultado |
---|---|---|---|---|
Uso básico | Utilice el estándar predeterminado | WCAG 2.0 AA (inmodificable en la configuración global) | No se especificó ninguna configuración | ✅ Pruebas ejecutadas utilizando WCAG 2.0 AA |
Anulación permitida | Utilice un estándar permitido diferente | WCAG 2.0 AA, puede utilizar 2.1 AA | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} |
✅ Pruebas ejecutadas utilizando WCAG 2.1 AA |
Anulación no autorizada | Utilice un estándar no autorizado | Solo WCAG 2.0 AA | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } |
❌ Error: Estándar no permitido |
Habilitar las mejores prácticas | Incluir comprobaciones de mejores prácticas | Mejores prácticas permitidas | configurationOverrides: { bestPractices: true } |
✅ Las pruebas incluyen las mejores prácticas |
Configuración mixta | Utilice reglas personalizadas con estándar | WCAG 2.0 AA (inmodificable) | runOptions: { rules: { 'color-contrast': { enabled: false } } } |
⚠️ Funciona pero muestra una advertencia |
Configuración heredada | Utilice la configuración de estilo antiguo | Cualquier | runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } |
⚠️ Funciona pero muestra una advertencia |
Combinación no válida | Mezclar configuraciones antiguas y nuevas | Cualquier | Usando ambos configurationOverrides y runOptions.runOnly |
❌ Error: No se pueden usar ambos |
Comprender los resultados
- ✅ Éxito: La configuración funciona como se esperaba
- ⚠️ Advertencia: La configuración funciona pero no se recomienda
- ❌ Error: La configuración fallará
Recomendaciones
- Siempre preferir
configurationOverrides
arunOptions
. - Verifique la configuración de su empresa antes de configurar anulaciones.
- Anule la configuración solo cuando sea necesario.
- Utilice la configuración más sencilla que se adapte a sus necesidades.
Ejemplo de anulación de configuración
A continuación, se muestra un ejemplo de configuración que demuestra las anulaciones a seguir WCAG 2.1 AA y las mejores prácticas:
const config = {
axe: {
apiKey: 'YOUR_API_KEY',
configurationOverrides: {
accessibilityStandard: 'WCAG 2.1 AA',
axeCoreVersion: '4.9.1',
experimentalRules: true,
bestPractices: true
}
};
Consulte Interfaz ConfigurationOverrides para obtener una explicación de las propiedades.
Errores y advertencias
Errores
Estándar no permitido
Si intenta utilizar un estándar que no está permitido, recibirá un código de respuesta del servidor 422, Contenido no procesable. Mensaje de ejemplo:
Error: Server responded to https://axe.deque.com/api-pub/watcher/sessions with status code 422: "error": "Invalid accessibility standard: WCAG 2.0 AA. Allowed options: EN 301 549, Trusted Tester v5"
Usando runOptions.runOnly
con configurationOverrides
Si utiliza ambos runOptions.runOnly
con configurationOverrides
, sus pruebas fallarán inmediatamente. Usar solo configurationOverrides
.
Advertencias
Usando runOptions.runOnly
Si utiliza runOptions.runOnly
en su configuración, recibirá este mensaje de advertencia:
@axe-core/watcher
Sin soporte de configuración global
Si utiliza una versión de @axe-core/watcher
que es demasiado antigua para tener soporte de configuración global, recibirá este mensaje: