Referencia de API para Java Playwright

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

Constructores

AxePlaywrightBuilder(Page)

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

public AxePlaywrightBuilder(Page page);

Parámetros

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 archivo contiene reglas personalizadas en un archivo JSON.

public AxePlaywrightBuilder(Page page, File rules);

Parámetros

Ejemplo

El siguiente ejemplo muestra cómo utilizar 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 Page especificado y el objeto de tipo String especificado, que contiene reglas personalizadas en una cadena JSON.

public AxePlaywrightBuilder(Page page, String rules);

Parámetros

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

analizar

Analice la Página de Playwright (especificada cuando se creó el objeto AxePlaywrightBuilder ) y devuelva un objeto AxeResults del análisis completado.

AxeResults AxePlaywrightBuilder.analyze();

Devoluciones

• AxeResults

Ejemplo

El siguiente ejemplo de código demuestra cómo utilizar el método analyze.

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
*/

configure(File)

Proporcione una configuración personalizada para 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

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);

configure(String)

Proporcionar una configuración personalizada para axe-core (la tecnología fundamental para el análisis de accesibilidad) se realiza mediante 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

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);

Desactivar reglas

Deshabilite la ejecución de reglas durante el análisis.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parámetros

Devoluciones

• AxePlaywrightBuilder

Ejemplo

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

// 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

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

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parámetros

Devoluciones

• AxePlaywrightBuilder

Ejemplos

En el ejemplo siguiente se 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"));

En el ejemplo siguiente se muestra cómo excluir elementos mediante selectores de iframe CSS.

// 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

Devoluciones

• AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo incluir dos clases diferentes en el análisis. Observe cómo el ejemplo utiliza el 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"))

setModoLegado

Excluye problemas de accesibilidad que puedan ocurrir en marcos e iframes entre dominios.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);

Devoluciones

• AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo activa el modo legado.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

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

public AxePlaywrightBuilder withAxeSource(File file);

Parámetros

Devoluciones

• AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo utilizar un archivo diferente para axe-core en lugar de la versión suministrada. Sería necesario hacer esto sólo en casos especializados.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

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

public AxePlaywrightBuilder withAxeSource(String src);

Parámetros

Devoluciones

• AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra cómo leer un archivo en una String y usarlo como archivo fuente con withAxeSource.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

Con solo reglas de mejores prácticas

Verifique los problemas de accesibilidad con solo el conjunto de reglas de buenas prácticas habilitado.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Devoluciones

• AxePlaywrightBuilder

Ejemplos

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

new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

withOnlyExperimentalRules

Comprueba si hay 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();

withRules

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

public AxePlaywrightBuilder exclude(List<String> rules);

Parámetros

Devuelve

• AxePlaywrightBuilder

Ejemplos

El siguiente ejemplo muestra dos formas diferentes de utilizar el método withRules . El primero crea una Lista con una regla, color-contrast. El segundo crea una Lista que contiene las reglas color-contrast y image-alt.

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

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

withTags

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

Devoluciones

• AxePlaywrightBuilder

Ejemplos

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

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

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