Referência da API para Java Playwright

Este documento fornece uma referência da API para a classe Java AxePlaywrightBuilder, que é fornecida pela integração Java do Playwright.

Construtores

AxePlaywrightBuilder(Page)

Inicializa uma nova instância da classe AxePlaywrightBuilder para o objeto Page especificado.

public AxePlaywrightBuilder(Page page);

Parâmetros

Exemplo

O exemplo de código a seguir demonstra este construtor. Também mostra como criar um objeto Page e um objeto AxePlaywrightBuilder com aquele objeto Page.

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

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Inicializa uma nova instância da classe AxePlaywrightBuilder com o objeto Page especificado e o objeto File especificado. O File contém regras personalizadas em um arquivo JSON.

public AxePlaywrightBuilder(Page page, File rules);

Parâmetros

Exemplo

O exemplo a seguir mostra como usar este construtor.

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

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

AxePlaywrightBuilder(Page, String)

Inicializa uma nova instância da classe AxePlaywrightBuilder com o objeto Page especificado e o objeto String especificado, que contém regras personalizadas em uma string JSON.

public AxePlaywrightBuilder(Page page, String rules);

Parâmetros

Exemplo

O exemplo de código a seguir demonstra este construtor.

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

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

Métodos

analisar

Analise a página do Playwright (especificada quando o objeto AxePlaywrightBuilder foi criado) e retorne um objeto AxeResults da análise concluída.

AxeResults AxePlaywrightBuilder.analyze();

Retorna

• AxeResults

Exemplo

O exemplo de código a seguir demonstra como usar o método de análise.

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(Arquivo)

Forneça uma configuração personalizada ao axe-core via um arquivo JSON.

public AxePlaywrightBuilder configure(File axeConfigure);

Para mais informações sobre o formato do arquivo de configuração, consulte configuração do axe-core.

Parâmetros

Exemplo

O exemplo a seguir mostra como acessar uma configuração e usá-la com um objeto AxePlaywrightBuilder.

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

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

configurar(String)

Forneça uma configuração personalizada ao axe-core (a tecnologia subjacente para analisar a acessibilidade) executada via uma string JSON.

public AxePlaywrightBuilder configure(String axeConfigure);

Para mais informações sobre o formato do arquivo de configuração, consulte configuração do axe-core.

Parâmetros

Exemplo

O exemplo a seguir mostra como acessar uma configuração e usá-la com um objeto AxePlaywrightBuilder.

String myAxeConfigure = "{..}"

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

desabilitarRegras

Desative regras para não serem executadas durante a análise.

public AxePlaywrightBuilder disableRules(List<String> rules);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplo

O exemplo a seguir mostra como desabilitar a verificação de acessibilidade para uma única regra usando o método singletonList da classe Collections e para várias regras usando um 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(String)

Especifique um único seletor CSS para excluir elementos HTML durante a análise. Para ignorar várias partes não relacionadas da página, chame exclude uma vez para cada uma, passando um único seletor cada vez.

public AxePlaywrightBuilder exclude(String selector);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como excluir elementos da análise com esses atributos:

• class="some-class"
• class="some-other-class"

new AxePlaywrightBuilder(page)
        .exclude(".some-class")
        .exclude(".some-other-class");

excluir(List<String>)

Especifique um seletor de iframe CSS para excluir elementos HTML durante a análise.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como excluir elementos usando seletores CSS de iframe.

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

Como não há sobrecarga de exclude(String...), passando mais de uma string para exclude também produz um único seletor de iframe em vez de exclusões separadas. A seguinte chamada resolve para excluir(Object...) e significa o mesmo que o exemplo acima.

new AxePlaywrightBuilder(page)
        .exclude("#parent-iframe", "#html")

excluir(FromFrames) expressa a mesma coisa de forma mais explícita e é a forma recomendada para novos testes.

excluir(FromFrames)

Exclua um elemento dentro de um ou mais iframes aninhados, usando um seletor explícito FromFrames.

public AxePlaywrightBuilder exclude(FromFrames fromFrames);

Importe a classe com import com.deque.html.axecore.args.FromFrames;.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir ignora o formulário dentro do iframe #payment-frame.

new AxePlaywrightBuilder(page)
        .exclude(new FromFrames("#payment-frame", "form"))

excluir(FromShadowDom)

Exclua um elemento dentro de uma ou mais árvores de shadow DOM aninhadas, usando um seletor explícito FromShadowDom.

public AxePlaywrightBuilder exclude(FromShadowDom fromShadowDom);

Importe a classe com import com.deque.html.axecore.args.FromShadowDom;.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir ignora o formulário #search dentro da raiz de sombra anexada a .app-header.

new AxePlaywrightBuilder(page)
        .exclude(new FromShadowDom(".app-header", "form#search"))

excluir(Object)

Exclua um seletor fornecido como um único objeto. Esta sobrecarga é selecionada apenas quando o tipo estático do argumento não é um dos tipos acima, como uma variável declarada como Object. Prefira as sobrecargas tipadas.

public AxePlaywrightBuilder exclude(Object selector);

Parâmetros

Retorna

• AxePlaywrightBuilder

exclude(Object...)

Exclua um seletor que mistura seletores CSS simples com seletores FromFrames ou FromShadowDom, para casos que as outras sobrecargas não podem expressar.

public AxePlaywrightBuilder exclude(Object... selector);

Esta sobrecarga é selecionada sempre que a chamada passa mais de um argumento. Passar um único FromFrames ou FromShadowDom seleciona exclude(FromFrames) ou exclude(FromShadowDom) em vez disso.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir ignora .target dentro da raiz de sombra anexada a #host, dentro do iframe #frame.

new AxePlaywrightBuilder(page)
        .exclude("#frame", new FromShadowDom("#host", ".target"))

include(String)

Especifique um único seletor CSS para incluir durante a análise. Para testar várias partes não relacionadas da página, chame include uma vez para cada uma, passando um único seletor cada vez.

public AxePlaywrightBuilder include(String selector);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como incluir duas classes diferentes na análise. Observe como o exemplo usa encadeamento de métodos para especificar mais de uma classe CSS.

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

include(List<String>)

Especifique um seletor de iframe CSS para incluir durante a análise.

public AxePlaywrightBuilder include(List<String> includeCSS);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como incluir elementos usando seletores CSS de iframe.

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

Como não há sobrecarga include(String...), passar mais de uma string para include também produz um único seletor de iframe em vez de inclusões separadas. A chamada a seguir resolve include(Object...) e significa a mesma coisa que o exemplo acima.

new AxePlaywrightBuilder(page)
        .include("#parent-iframe", "#html")

include(FromFrames) expressa a mesma coisa de forma mais explícita e é a forma recomendada para novos testes.

include(FromFrames)

Inclua um elemento dentro de um ou mais iframes aninhados, usando um seletor FromFrames explícito.

public AxePlaywrightBuilder include(FromFrames fromFrames);

Importe a classe com import com.deque.html.axecore.args.FromFrames;.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir testa o formulário dentro do iframe #payment-frame.

new AxePlaywrightBuilder(page)
        .include(new FromFrames("#payment-frame", "form"))

include(FromShadowDom)

Inclua um elemento dentro de uma ou mais árvores de DOM sombra aninhadas, usando um seletor FromShadowDom explícito.

public AxePlaywrightBuilder include(FromShadowDom fromShadowDom);

Importe a classe com import com.deque.html.axecore.args.FromShadowDom;.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir testa a #search formulário dentro da raiz de sombra anexada a .app-header.

new AxePlaywrightBuilder(page)
        .include(new FromShadowDom(".app-header", "form#search"))

include(Object)

Inclua um seletor fornecido como um único objeto. Esta sobrecarga é selecionada apenas quando o tipo estático do argumento não é um dos tipos acima, como uma variável declarada como Object. Prefira as sobrecargas tipadas.

public AxePlaywrightBuilder include(Object selector);

Parâmetros

Retorna

• AxePlaywrightBuilder

include(Object...)

Inclua um seletor que mistura seletores CSS simples com seletores FromFrames ou FromShadowDom, para casos que as outras sobrecargas não podem expressar.

public AxePlaywrightBuilder include(Object... selector);

Esta sobrecarga é selecionada sempre que a chamada passa mais de um argumento. Passar um único FromFrames ou FromShadowDom seleciona include(FromFrames) ou include(FromShadowDom) em vez disso.

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir testa .target dentro da raiz de sombra anexada a #host, dentro do iframe #frame.

new AxePlaywrightBuilder(page)
        .include("#frame", new FromShadowDom("#host", ".target"))

setModoLegado

Exclui problemas de acessibilidade que podem ocorrer em frames e iframes de domínio cruzado.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir ativa o modo legado.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

comFonteAxe(File)

Forneça uma versão personalizada do axe-core usando o objeto File do Java

public AxePlaywrightBuilder withAxeSource(File file);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como usar um arquivo diferente para axe-core em vez da versão fornecida. Você precisaria fazer isso apenas em casos especializados.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

Forneça uma versão personalizada do axe-core usando uma fonte já analisada

public AxePlaywrightBuilder withAxeSource(String src);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como ler um arquivo em um String e usá-lo como o arquivo fonte com withAxeSource.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

withOnlyBestPracticeRules

Verifique problemas de acessibilidade com apenas o conjunto de regras das melhores práticas ativado.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como habilitar a análise de acessibilidade usando apenas as regras de melhores práticas.

new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

withOnlyExperimentalRules

Verifique problemas de acessibilidade com apenas o conjunto de regras experimentais ativado

public AxePlaywrightBuilder withOnlyExperimentalRules();

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra como habilitar a análise de acessibilidade usando apenas as regras experimentais.

new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

withRules

Limite as regras a serem executadas durante a análise de acessibilidade para aquelas especificadas.

public AxePlaywrightBuilder exclude(List<String> rules);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

O exemplo a seguir mostra duas maneiras diferentes de usar o método withRules. O primeiro cria um List com uma regra, contraste de cor. O segundo cria um List contendo as regras contraste de cor e imagem-alt.

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

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

comTags

Limita a análise de acessibilidade ao conjunto de regras ou conjuntos de regras pertencentes às tags especificadas.

public AxePlaywrightBuilder withTags(List<String> tags);

Parâmetros

Retorna

• AxePlaywrightBuilder

Exemplos

Este exemplo mostra como limitar a análise de acessibilidade às regras pertencentes às tags especificadas. O primeiro trecho de código mostra como limitar a análise às regras que fazem parte da especificação wcag21aa. O segundo trecho mostra como limitar a análise à especificação wcag21aa e às regras best-practice.

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

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