Riferimento API per Java Playwright
Questo documento fornisce un riferimento API alla classe Java AxePlaywrightBuilder , fornita dall'integrazione Java di Playwright.
La maggior parte dei metodi in AxePlaywrightBuilder classe restituiscono un oggetto AxePlaywrightBuilder , che consente di concatenare facilmente più metodi. Per esempi di concatenazione di metodi, vedere gli esempi di codice riportati di seguito.
Costruttori
| Costruttore | Descrizione |
|---|---|
| AxePlaywrightBuilder(Pagina) | Costruttore standard che crea un oggetto AxePlaywrightBuilder . |
| AxePlaywrightBuilder(Pagina, File) | Crea un oggetto AxePlaywrightBuilder e specifica un file JSON contenente regole personalizzate da utilizzare durante l'analisi. |
| AxePlaywrightBuilder(Pagina, Stringa) | Crea un oggetto AxePlaywrightBuilder specificando una stringa JSON contenente regole personalizzate. |
AxePlaywrightBuilder(Page)
Inizializza una nuova istanza della classe AxePlaywrightBuilder per l'oggetto Page specificato.
public AxePlaywrightBuilder(Page page);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| pagina | com.microsoft.Playwright.Page | Oggetto Page da utilizzare per l'analisi dell'accessibilità. |
Esempio
Il seguente esempio di codice illustra questo costruttore. Mostra anche come creare un oggetto Page e un oggetto AxePlaywrightBuilder con quell'oggetto Page .
// Example Page
Page page = browser.newPage();
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);AxePlaywrightBuilder(Page, File)
Inizializza una nuova istanza della classe AxePlaywrightBuilder con l'oggetto Page specificato e l'oggetto File specificato. Il File contiene regole personalizzate in un file JSON.
public AxePlaywrightBuilder(Page page, File rules);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| pagina | com.microsoft.Playwright.Page | L'oggetto Page richiesto. |
| regole | File | Un oggetto File che rappresenta un file JSON di regole di accessibilità personalizzate. |
Esempio
L'esempio seguente mostra come utilizzare questo costruttore.
// Example Page
Page page = browser.newPage();
File customRuleset = new File("somePath/custom-ruleset.json")
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);AxePlaywrightBuilder(Page, String)
Inizializza una nuova istanza della classe AxePlaywrightBuilder con l'oggetto Page specificato e l'oggetto String specificato, che contiene regole personalizzate in una stringa JSON.
public AxePlaywrightBuilder(Page page, String rules);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| pagina | com.microsoft.Playwright.Page | L'oggetto richiesto Page |
| regole | String | Una stringa JSON che rappresenta un insieme di regole di accessibilità personalizzate. |
Esempio
Il seguente esempio di codice illustra questo costruttore.
// Example Page
Page page = browser.newPage();
String customRuleset = "{...}"
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page, customRuleset);Metodi
| Metodo | Descrizione |
|---|---|
| analizza | Analizza la pagina Playwright e restituisce un oggetto AxeResults dall'analisi completata. |
| configure(File) | Fornisce una configurazione personalizzata su come axe-core viene eseguito tramite un file JSON. |
| configure(String) | Fornisci una configurazione personalizzata su come axe-core viene eseguito tramite una stringa JSON. |
| disableRules | Impedisce l'esecuzione delle regole specificate durante l'analisi. |
| exclude | Specifica i selettori CSS da utilizzare per escludere determinati contenuti HTML durante l'analisi. |
| include | Specifica i selettori CSS da utilizzare per includere contenuto HTML durante l'analisi. |
| impostaModalitàLegacy | Imposta la modalità legacy per escludere i problemi di accessibilità che potrebbero verificarsi nei frame e negli iframe cross-domain. |
| conAxeSource(File) | Fornire una versione personalizzata di axe-core utilizzando un oggetto File . |
| conAxeSource(Stringa) | Fornire una versione personalizzata di axe-core utilizzando un oggetto String . |
| conSoloRegole delle Migliori Pratiche | Controlla l'accessibilità utilizzando solo le regole di best practice. |
| conSoloRegoleSperimentali | Controlla l'accessibilità utilizzando solo le regole sperimentali. |
| conRegole | Limita le regole di accessibilità a quelle specificate. |
| conTag | Limita le regole di accessibilità verificate all'elenco di tag specificato. |
analizzare
Analizza la pagina Playwright (specificata quando è stato creato l'oggetto AxePlaywrightBuilder ) e restituisce un oggetto AxeResults dall'analisi completata.
AxeResults AxePlaywrightBuilder.analyze();Resi
- AxeResults
Esempio
Il seguente esempio di codice mostra come utilizzare il metodo 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)
Fornire una configurazione personalizzata ad axe-core tramite un file JSON.
public AxePlaywrightBuilder configure(File axeConfigure);Per maggiori informazioni sul formato del file di configurazione, vedere axe-core configuration.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| file | File | Un oggetto File che rappresenta una configurazione axe-core in JSON. |
Esempio
L'esempio seguente mostra come accedere a una configurazione e utilizzarla con un oggetto AxePlaywrightBuilder .
File myAxeConfigure = new File("./axe-configure.json");
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
.configure(myAxeConfigure);
configure(String)
Fornire una configurazione personalizzata ad axe-core (la tecnologia di base per l'analisi dell'accessibilità) che viene eseguita tramite una stringa JSON.
public AxePlaywrightBuilder configure(String axeConfigure);Per maggiori informazioni sul formato del file di configurazione, vedere axe-core configuration.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| axeConfig | String | Oggetto String che rappresenta una configurazione axe-core in JSON. |
Esempio
L'esempio seguente mostra come accedere a una configurazione e utilizzarla con un oggetto AxePlaywrightBuilder .
String myAxeConfigure = "{..}"
AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page)
.configure(myAxeConfigure);Disabilitare le regole
Disattiva l'esecuzione delle regole durante l'analisi.
public AxePlaywrightBuilder disableRules(List<String> rules);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| regole | List<String> | Un elenco di stringhe che rappresentano le regole da disattivare durante l'analisi. |
Ritorni
- Costruttore di AxePlaywright
Esempio
L'esempio seguente mostra come disabilitare il controllo di accessibilità per una singola regola utilizzando il metodo singletonList della classe Collections e più regole utilizzando un 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"));escludere
Specificare i selettori CSS per escludere gli elementi HTML durante l'analisi.
public AxePlaywrightBuilder exclude(List<String> excludeCSS);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| excludeCSS | Lista<String> | Una lista di selettori CSS che specificano gli elementi che non verranno inclusi in un'analisi di accessibilità. |
Ritorni
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come escludere elementi dall'analisi con questi attributi:
- class="some-class"
- class="some-other-class"
new AxePlaywrightBuilder(page)
.exclude(Collections.singletonList(".some-class"))
.exclude(Collections.singletonList(".some-other-class"));
L'esempio seguente mostra come escludere elementi utilizzando i selettori iframe CSS.
// To exclude everything within html of parent-iframe
new AxePlaywrightBuilder(page)
.exclude(Arrays.asList("#parent-iframe", "#html"))include
Selettori CSS da includere durante l'analisi
public AxePlaywrightBuilder include(List<String> includeCSS);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| includeCSS | Lista<String> | Un elenco di selettori CSS che specificano gli elementi che saranno inclusi in un'analisi di accessibilità. |
Ritorni
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come includere due classi diverse nell'analisi. Si noti come l'esempio utilizzi il concatenamento dei metodi per specificare più di una classe CSS.
new AxePlaywrightBuilder(page)
.include(Collections.singletonList(".some-class"))
.include(Collections.singletonList(".some-other-class"));
L'esempio seguente mostra come includere elementi utilizzando i selettori iframe CSS.
// To include everything within html of parent-iframe
new AxePlaywrightBuilder(page)
.include(Arrays.asList("#parent-iframe", "#html"))impostaLegacyMode
Esclude i problemi di accessibilità che potrebbero verificarsi nei frame e negli iframe cross-domain.
public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);Si prevede che questa API verrà rimossa nella prossima versione di axe DevTools.
Resi
- Costruttore di AxePlaywright
Esempi
L'esempio seguente attiva la modalità legacy.
new AxePlaywrightBuilder(page)
.setLegacyMode(true);withAxeSource(File)
Fornire una versione personalizzata di axe-core utilizzando l'oggetto File di Java
public AxePlaywrightBuilder withAxeSource(File file);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| file | File | Un file contenente JavaScript che implementa axe-core. |
Resi
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come utilizzare un file diverso per axe-core invece della versione fornita. Questa operazione sarebbe necessaria solo in casi particolari.
File axeLegacySource = new File("somepath/axe-core@legacy.js");
new AxePlaywrightBuilder(page)
.withAxeSource(axeLegacySource);withAxeSource(String)
Fornire una versione personalizzata di axe-core utilizzando una sorgente già analizzata
public AxePlaywrightBuilder withAxeSource(String src);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| src | String | Il file sorgente JavaScript è rappresentato come una String. |
Resi
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come leggere un file in una String e utilizzarlo come file sorgente con withAxeSource.
String source = IOUtils.toString(somepPath.toURI(), StandardCharsets.UTF_8);
new AxePlaywrightBuilder(page)
.withAxeSource(source);withOnlyBestPracticeRules
Verificare la presenza di problemi di accessibilità abilitando solo il set di regole ottimali.
public AxePlaywrightBuilder withOnlyBestPracticeRules();Resi
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come abilitare l'analisi dell'accessibilità utilizzando solo le regole delle best practice.
new AxePlaywrightBuilder(page)
.withOnlyBestPracticeRules();
conSoloRegoleSperimentali
Verificare i problemi di accessibilità con solo il set di regole sperimentale abilitato
public AxePlaywrightBuilder withOnlyExperimentalRules();Restituisce
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra come abilitare l'analisi dell'accessibilità utilizzando solo le regole sperimentali.
new AxePlaywrightBuilder(page)
.withOnlyExperimentalRules();
conRegole
Limitare le regole da eseguire durante l'analisi di accessibilità a quelle specificate.
public AxePlaywrightBuilder exclude(List<String> rules);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| norme | Lista<String> | Elenco di regole da utilizzare per l'analisi dell'accessibilità. |
Restituisce
- Costruttore di AxePlaywright
Esempi
L'esempio seguente mostra due modi diversi di utilizzare il metodo withRules . Il primo crea una Lista con una regola, color-contrast. Il secondo crea una Lista contenente le regole color-contrast e image-alt.
// Single Rule
new AxePlaywrightBuilder(page)
.withRules(Collections.singletonList("color-contrast"));
// Multiple Rules
new AxePlaywrightBuilder(page)
.withRules(Arrays.asList("color-contrast", "image-alt"));conTags
Limita l'analisi dell'accessibilità al set di regole o ai set di regole appartenenti ai tag specificati.
public AxePlaywrightBuilder withTags(List<String> tags);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| tag | Lista<String> | Un elenco di tag che includono le regole che desideri includere nell'analisi di accessibilità. |
Resi
- Costruttore di AxePlaywright
Esempi
Questo esempio mostra come limitare l'analisi dell'accessibilità alle regole appartenenti ai tag specificati. Il primo frammento di codice mostra come limitare l'analisi alle regole che fanno parte della specifica wcag21aa . Il secondo frammento mostra come limitare l'analisi alla specifica wcag21aa e alle regole delle best practice .
// Single tag
new AxePlaywrightBuilder(page)
.withTags(Collections.singletonList("wcag21aa"));
// Multiple tags
new AxePlaywrightBuilder(page)
.withTags(Arrays.asList("wcag21aa", "best-practice"));