io.percy.selenium

Class Percy

java.lang.Object

io.percy.selenium.Percy

public class Percy
extends Object

Percy client for visual testing.

Constructor Summary

Constructors

Constructor and Description
Percy(org.openqa.selenium.WebDriver driver)

Method Summary

Modifier and Type	Method and Description
void	snapshot(String name) Take a snapshot and upload it to Percy.
void	snapshot(String name, List<Integer> widths) Take a snapshot and upload it to Percy.
void	snapshot(String name, List<Integer> widths, Integer minHeight) Take a snapshot and upload it to Percy.
void	snapshot(String name, List<Integer> widths, Integer minHeight, boolean enableJavaScript) Take a snapshot and upload it to Percy.
void	snapshot(String name, List<Integer> widths, Integer minHeight, boolean enableJavaScript, String percyCSS) Take a snapshot and upload it to Percy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Percy

public Percy(org.openqa.selenium.WebDriver driver)

Parameters:

driver - The Selenium WebDriver object that will hold the browser session to snapshot.

Method Detail

snapshot

public void snapshot(String name)

Take a snapshot and upload it to Percy.

Parameters:

name - The human-readable name of the snapshot. Should be unique.

snapshot

public void snapshot(String name,
                     List<Integer> widths)

Take a snapshot and upload it to Percy.

Parameters:

name - The human-readable name of the snapshot. Should be unique.

widths - The browser widths at which you want to take the snapshot. In pixels.

snapshot

public void snapshot(String name,
                     List<Integer> widths,
                     Integer minHeight)

Take a snapshot and upload it to Percy.

Parameters:

name - The human-readable name of the snapshot. Should be unique.

widths - The browser widths at which you want to take the snapshot. In pixels.

minHeight - The minimum height of the resulting snapshot. In pixels.

snapshot

public void snapshot(String name,
                     List<Integer> widths,
                     Integer minHeight,
                     boolean enableJavaScript)

Take a snapshot and upload it to Percy.

Parameters:

name - The human-readable name of the snapshot. Should be unique.

widths - The browser widths at which you want to take the snapshot. In pixels.

minHeight - The minimum height of the resulting snapshot. In pixels.

enableJavaScript - Enable JavaScript in the Percy rendering environment

snapshot

public void snapshot(String name,
                     @Nullable
                     List<Integer> widths,
                     Integer minHeight,
                     boolean enableJavaScript,
                     String percyCSS)

Take a snapshot and upload it to Percy.

Parameters:

name - The human-readable name of the snapshot. Should be unique.

widths - The browser widths at which you want to take the snapshot. In pixels.

minHeight - The minimum height of the resulting snapshot. In pixels.

enableJavaScript - Enable JavaScript in the Percy rendering environment

percyCSS - Percy specific CSS that is only applied in Percy's browsers