Référence API pour Java Playwright

Ce document fournit une référence API à la classe Java AxePlaywrightBuilder , qui est fournie par l'intégration Playwright Java.

Constructeurs

AxePlaywrightBuilder(Page)

Initialise une nouvelle instance de la classe AxePlaywrightBuilder pour l'objet Page spécifié.

public AxePlaywrightBuilder(Page page);

Paramètres

Exemple

L'exemple de code suivant illustre ce constructeur. Il montre également comment créer un objet Page et un objet AxePlaywrightBuilder avec cet objet Page.

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

AxePlaywrightBuilder axePlaywrightBuilder = new AxePlaywrightBuilder(page);

AxePlaywrightBuilder(Page, File)

Initialise une nouvelle instance de la classe AxePlaywrightBuilder avec l'objet Page spécifié et l'objet File donné. Le fichier contient des règles personnalisées dans un fichier JSON.

public AxePlaywrightBuilder(Page page, File rules);

Paramètres

Exemple

L'exemple suivant montre comment utiliser ce constructeur.

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

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

AxePlaywrightBuilder(Page, String)

Initialise une nouvelle instance de la classe AxePlaywrightBuilder avec l'objet Page spécifié et l'objet String donné, qui contient des règles personnalisées dans une chaîne JSON.

public AxePlaywrightBuilder(Page page, String rules);

Paramètres

Exemple

L'exemple de code suivant illustre ce constructeur.

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

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

Méthodes

analyser

Analysez la page Playwright (spécifiée lors de la création de l'objet AxePlaywrightBuilder ) et renvoyez un objet AxeResults à partir de l'analyse terminée.

AxeResults AxePlaywrightBuilder.analyze();

Retours

• AxeResults

Exemple

L'exemple de code suivant montre comment utiliser la méthode 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)

Fournissez une configuration personnalisée à axe-core via un fichier JSON.

public AxePlaywrightBuilder configure(File axeConfigure);

Pour plus d'informations sur le format du fichier de configuration, voir axe-core configuration.

Paramètres

Exemple

L'exemple suivant montre comment accéder à une configuration et l'utiliser avec un objet AxePlaywrightBuilder.

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

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

configure(String)

Fournir une configuration personnalisée à axe-core (la technologie sous-jacente pour l'analyse de l'accessibilité) s'exécute via une chaîne JSON.

public AxePlaywrightBuilder configure(String axeConfigure);

Pour plus d'informations sur le format du fichier de configuration, voir axe-core configuration.

Paramètres

Exemple

L'exemple suivant montre comment accéder à une configuration et l'utiliser avec un objet AxePlaywrightBuilder.

String myAxeConfigure = "{..}"

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

disableRules

Désactiver l'exécution des règles pendant l'analyse.

public AxePlaywrightBuilder disableRules(List<String> rules);

Paramètres

Retours

• AxePlaywrightBuilder

Exemple

L'exemple suivant montre comment désactiver la vérification d'accessibilité pour une seule règle à l'aide de la méthode singletonList de la classe Collections et plusieurs règles à l'aide d'une 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"));

exclure

Spécifiez les sélecteurs CSS pour exclure les éléments HTML lors de l'analyse.

public AxePlaywrightBuilder exclude(List<String> excludeCSS);

Paramètres

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment exclure des éléments de l'analyse avec ces attributs :

• class="une-classe"
• class="une-autre-classe"

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

L'exemple suivant montre comment exclure des éléments à l'aide de sélecteurs iframe CSS.

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

comprend

Sélecteurs CSS à inclure lors de l'analyse

public AxePlaywrightBuilder include(List<String> includeCSS);

Paramètres

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment inclure deux classes différentes dans l'analyse. Notez comment l’exemple utilise le chaînage de méthodes pour spécifier plusieurs classes CSS.

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

L'exemple suivant montre comment inclure des éléments à l'aide de sélecteurs CSS d'iframe.

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

définirLegacyMode

Exclut les problèmes d’accessibilité qui peuvent survenir dans les cadres et les iframes inter-domaines.

public AxePlaywrightBuilder setLegacyMode(boolean legacyMode);

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant active le mode legacy.

new AxePlaywrightBuilder(page)
        .setLegacyMode(true);

withAxeSource(File)

Fournir une version personnalisée d'axe-core à l'aide de l'objet File de Java

public AxePlaywrightBuilder withAxeSource(File file);

Paramètres

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment utiliser un fichier différent pour axe-core au lieu de la version fournie. Vous n’aurez besoin de le faire que dans des cas particuliers.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(axeLegacySource);

withAxeSource(String)

Fournir une version personnalisée d'axe-core en utilisant une source déjà analysée

public AxePlaywrightBuilder withAxeSource(String src);

Paramètres

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment lire un fichier dans une chaîne et l'utiliser comme fichier source avec withAxeSource.

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

new AxePlaywrightBuilder(page)
        .withAxeSource(source);

withOnlyBestPracticeRules

Vérifiez les problèmes d’accessibilité en activant uniquement les règles des meilleures pratiques.

public AxePlaywrightBuilder withOnlyBestPracticeRules();

Retours

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment activer l'analyse d'accessibilité en utilisant uniquement les règles de bonnes pratiques.

new AxePlaywrightBuilder(page)
        .withOnlyBestPracticeRules();

Avec des règles expérimentales uniquement

Vérifiez les problèmes d'accessibilité avec l'ensemble de règles expérimentales activées uniquement

public AxePlaywrightBuilder withOnlyExperimentalRules();

Renvoie

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre comment activer l'analyse d'accessibilité en utilisant uniquement les règles expérimentales.

new AxePlaywrightBuilder(page)
        .withOnlyExperimentalRules();

Avec des règles

Limitez les règles à exécuter lors de l’analyse d’accessibilité à celles spécifiées.

public AxePlaywrightBuilder exclude(List<String> rules);

Paramètres

Renvoie

• AxePlaywrightBuilder

Exemples

L'exemple suivant montre deux manières différentes d'utiliser la méthode withRules . Le premier crée une liste avec une règle, couleur-contraste. La seconde crée une Liste contenant les règles couleur-contraste et image-alt.

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

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

avec des tags

Limite l'analyse d'accessibilité à l'ensemble de règles ou aux ensembles de règles appartenant aux balises spécifiées.

public AxePlaywrightBuilder withTags(List<String> tags);

Paramètres

Retours

• AxePlaywrightBuilder

Exemples

Cet exemple montre comment limiter l'analyse d'accessibilité aux règles appartenant aux étiquettes spécifiées. Le premier extrait de code montre comment limiter l'analyse aux règles qui font partie de la spécification wcag21aa. Le deuxième extrait montre comment limiter l'analyse à la spécification wcag21aa et aux règles de meilleures pratiques.

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

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