Referencia de API para Java Playwright

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 de API para la clase AxePlaywrightBuilder en la integración de Axe DevTools para Web Java Playwright

Not for use with personal data

Este documento proporciona una referencia de API para la clase AxePlaywrightBuilder de Java, que es ofrecida por la integración de Playwright Java.

note

La mayoría de los métodos en la clase AxePlaywrightBuilder devuelven un objeto AxePlaywrightBuilder, lo que te permite encadenar varios métodos fácilmente. Consulta los ejemplos de código a continuación para ver ejemplos de encadenamiento de métodos.

Constructores

Constructor Descripción
AxePlaywrightBuilder(Page) Constructor estándar que crea un objeto AxePlaywrightBuilder.
AxePlaywrightBuilder(Page, File) Crea un objeto AxePlaywrightBuilder y especifica un archivo JSON que contiene reglas personalizadas para ser usadas durante el análisis.
AxePlaywrightBuilder(Page, String) Crea un objeto AxePlaywrightBuilder mientras especificas un String JSON que contiene reglas personalizadas.

AxePlaywrightBuilder(Page)

Inicializa una nueva instancia de la clase AxePlaywrightBuilder para el objeto Page especificado.

public AxePlaywrightBuilder(Page page);

Parámetros

Nombre Tipo Descripción
page com.microsoft.Playwright.Page El objeto Page que se usará para el análisis de accesibilidad.

Ejemplo

El siguiente ejemplo de código demuestra este constructor. También muestra cómo crear un objeto Page y un objeto AxePlaywrightBuilder con ese objeto Page.

// Example Page
Page page = browser.newPage();

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Inicializa una nueva instancia de la clase AxePlaywrightBuilder con el objeto Page especificado y el objeto File especificado. El File contiene reglas personalizadas en un archivo JSON.

public AxePlaywrightBuilder(Page page, File rules);

Parámetros

Nombre Tipo Descripción
page com.microsoft.Playwright.Page El objeto Page requerido.
rules File Un objeto File que representa un archivo JSON de reglas de accesibilidad personalizadas.

Ejemplo

El siguiente ejemplo muestra cómo usar este constructor.

// Example Page
Page page = browser.newPage();

File customRuleset = new File("somePath/custom-ruleset.json")
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

AxePlaywrightBuilder(Page, String)

Inicializa una nueva instancia de la clase AxePlaywrightBuilder con el objeto Página especificado y el objeto Cadena especificado, que contiene reglas personalizadas en una cadena JSON.

public AxePlaywrightBuilder(Page page, String rules);

Parámetros

Nombre Tipo Descripción
página com.microsoft.Playwright.Page El objeto Página requerido
reglas Cadena Una cadena JSON que representa un conjunto de reglas de accesibilidad personalizadas.

Ejemplo

El siguiente ejemplo de código demuestra este constructor.

// Example Page
Page page = browser.newPage();

String customRuleset = "{...}"
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);

Métodos

Método Descripción
analizar Analiza la página de Playwright y devuelve un objeto ResultadosAxe del análisis completado.
configurar(Archivo) Proporciona una configuración personalizada sobre cómo se ejecuta axe-core a través de un archivo JSON.
configurar(Cadena) Proporciona una configuración personalizada sobre cómo se ejecuta axe-core a través de una cadena JSON.
deshabilitarReglas Impide que se ejecuten las reglas especificadas durante el análisis.
excluir Especifica los selectores CSS que se utilizarán para excluir cierto contenido HTML durante el análisis.
incluir Especifica los selectores CSS que incluyen contenido HTML durante el análisis.
establecerModoAntiguo Establece el modo antiguo para excluir problemas de accesibilidad que pueden ocurrir en marcos y iframes de dominios cruzados.
conFuenteAxe(Archivo) Proporciona una versión personalizada de axe-core usando un objeto Archivo.
conFuenteAxe(Cadena) Proporciona una versión personalizada de axe-core usando un objeto Cadena.
conSoloReglasDeMejoresPrácticas Verifica la accesibilidad usando solo las reglas de mejores prácticas.
conSoloReglasExperimentales Verifica la accesibilidad usando solo las reglas experimentales.
conReglas Limita las reglas de accesibilidad a las especificadas.
conEtiquetas Limita las reglas de accesibilidad verificadas a la lista especificada de etiquetas.

analizar

Analiza la página de Playwright (especificada cuando se creó el objeto AxePlaywrightBuilder) y devuelve un objeto AxeResults del análisis completado.

AxeResults AxePlaywrightBuilder.analyze();

Devuelve

  • AxeResults

Ejemplo

El siguiente ejemplo de código demuestra cómo usar el método analizar.


AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxeResults axeResults = axePlaywrightBuilder.analyze();

/* Usage may include:
axeResults.getViolations() - returns only violation results
axeResults.getPasses() - returns only pass results
axeResults.getIncomplete() - returns only incomplete results
*/

configurar(Archivo)

Proporciona una configuración personalizada a axe-core a través de un archivo JSON.

public AxePlaywrightBuilder configure(File axeConfigure);

Para obtener más información sobre el formato del archivo de configuración, consulte configuración de axe-core.

Parámetros

Nombre Tipo Descripción
archivo Archivo Un objeto Archivo que representa una configuración de axe-core en JSON.

Ejemplo

El siguiente ejemplo muestra cómo acceder a una configuración y usarla con un objeto AxePlaywrightBuilder.

File myAxeConfigure = new File("./axe-configure.json");

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

configurar(Cadena)

Proporciona una configuración personalizada a axe-core (la tecnología subyacente para analizar accesibilidad) que se ejecuta a través de una cadena JSON.

public AxePlaywrightBuilder configure(String axeConfigure);

Para obtener más información sobre el formato del archivo de configuración, consulte configuración de axe-core.

Parámetros

Nombre Tipo Descripción
axeConfig Cadena Un objeto Cadena que representa una configuración de axe-core en JSON.

Ejemplo

El siguiente ejemplo muestra cómo acceder a una configuración y usarla con un objeto AxePlaywrightBuilder.

String myAxeConfigure = "{..}"

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
        .configure(myAxeConfigure);

deshabilitarReglas

Desactiva reglas para que no se ejecuten durante el análisis.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parámetros

Nombre Tipo Descripción
reglas Lista<Cadena> Una lista de cadenas que representan reglas a deshabilitar durante el análisis.

Devuelve

  • AxePlaywrightBuilder

Ejemplo

El siguiente ejemplo muestra cómo deshabilitar la comprobación de accesibilidad para una sola regla usando el método singletonList de la clase Colecciones y múltiples reglas usando un Lista.

// Single Rule
AxePlaywrightBuilder axePlaywrightBuilder1 = new AxePlaywrightBuilder(page)
        .disableRules(Collections.singletonList("color-contrast"));

// Multiple Rules
AxePlaywrightBuilder axePlaywrightBuilder2 = new AxePlaywrightBuilder(page)
        .disableRules(Arrays.asList("color-contrast", "image-alt"));

excluir

Especificar los selectores CSS para excluir elementos HTML durante el análisis.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parámetros

Nombre Tipo Descripción
excludeCSS Lista<String> Una lista de selectores CSS que especifican elementos que no se incluirán en un análisis de accesibilidad.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo excluir elementos del análisis con estos atributos:

  • class="some-class"
  • class="some-other-class"
new AxePlaywrightBuilder(page)
        .exclude(Collections.singletonList(".some-class"))
        .exclude(Collections.singletonList(".some-other-class"));

El siguiente ejemplo muestra cómo excluir elementos utilizando selectores CSS de iframe.

// To exclude everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .exclude(Arrays.asList("#parent-iframe", "#html"))

incluir

Selectores CSS para incluir durante el análisis

public AxePlaywrightBuilder include(List<String> includeCSS);

Parámetros

Nombre Tipo Descripción
includeCSS Lista<String> Una lista de selectores CSS que especifican elementos que se incluirán en un análisis de accesibilidad.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo incluir dos clases diferentes en el análisis. Observe cómo el ejemplo utiliza encadenamiento de métodos para especificar más de una clase CSS.

new AxePlaywrightBuilder(page)
        .include(Collections.singletonList(".some-class"))
        .include(Collections.singletonList(".some-other-class"));

El siguiente ejemplo muestra cómo incluir elementos utilizando selectores CSS de iframe.

// To include everything within html of parent-iframe
new AxePlaywrightBuilder(page)
        .include(Arrays.asList("#parent-iframe", "#html"))

establecerModoLegado

Excluye problemas de accesibilidad que pueden ocurrir en marcos y iframes de dominio cruzado.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);
note

Se espera que esta API se elimine en la próxima versión de Axe DevTools.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo activa el modo legado.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

conFuenteAxe(Archivo)

Proporcionar una versión personalizada de axe-core utilizando el objeto File de Java

public AxePlaywrightBuilder withAxeSource(File file);

Parámetros

Nombre Tipo Descripción
archivo Archivo Un archivo que contiene JavaScript que implementa axe-core.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo usar un archivo diferente para axe-core en lugar de la versión suministrada. Solo necesitarías hacer esto en casos especializados.

File axeLegacySource = new File("somepath/axe-core@legacy.js");

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

conFuenteAxe(String)

Proporciona una versión personalizada de axe-core utilizando una fuente ya analizada

public AxePlaywrightBuilder withAxeSource(String src);

Parámetros

Nombre Tipo Descripción
src Cadena El archivo fuente de JavaScript representado como Cadena.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo leer un archivo en un Cadena y usar eso como el archivo fuente con conFuenteAxe.

String source = IOUtils.toString(somepPath.toURI(), StandardCharsets.UTF_8);

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

conSoloReglasDeMejoresPrácticas

Verifica problemas de accesibilidad con solo el conjunto de reglas de mejores prácticas habilitado.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo habilitar el análisis de accesibilidad utilizando solo las reglas de mejores prácticas.


new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

conSoloReglasExperimentales

Verifica problemas de accesibilidad con solo el conjunto de reglas experimentales habilitado

public AxePlaywrightBuilder withOnlyExperimentalRules();

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo habilitar el análisis de accesibilidad utilizando solo las reglas experimentales.


new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

conReglas

Limite las reglas que se ejecutarán durante el análisis de accesibilidad a las especificadas.

public AxePlaywrightBuilder exclude(List<String> rules);

Parámetros

Nombre Tipo Descripción
reglas Lista<Cadena> Una lista de reglas a utilizar para el análisis de accesibilidad.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra dos formas diferentes de usar el método conReglas. El primero crea un Lista con una regla, contraste-de-color. El segundo crea un Lista que contiene las reglas color-contrast y texto alternativo de imagen.

// Single Rule
new AxePlaywrightBuilder(page)
        .withRules(Collections.singletonList("color-contrast"));

// Multiple Rules
new AxePlaywrightBuilder(page)
        .withRules(Arrays.asList("color-contrast", "image-alt"));

conTags

Limita el análisis de accesibilidad al conjunto de reglas o conjuntos de reglas que pertenecen a las etiquetas especificadas.

public AxePlaywrightBuilder withTags(List<String> tags);

Parámetros

Nombre Tipo Descripción
etiquetas List<String> Una lista de etiquetas que incluyen las reglas que deseas incluir en el análisis de accesibilidad.

Devuelve

  • AxePlaywrightBuilder

Ejemplos

Este ejemplo muestra cómo limitar el análisis de accesibilidad a reglas que pertenecen a las etiquetas especificadas. El primer fragmento de código muestra cómo limitar el análisis a reglas que son parte de la especificación wcag21aa. El segundo fragmento muestra cómo limitar el análisis a la especificación wcag21aa y a las reglas mejores prácticas.

// Single tag
new AxePlaywrightBuilder(page)
        .withTags(Collections.singletonList("wcag21aa"));

// Multiple tags
 new AxePlaywrightBuilder(page)
        .withTags(Arrays.asList("wcag21aa", "best-practice"));

Is this page helpful?

Help us improve this page

Still need help?