assertView
Overview
Use the assertView command to take a screenshot of an element for a specific test state and compare it with a reference.
This command is implemented within Testplane and is not available in the API WebDriverIO.
Usage
await browser.$(selector).assertView(state, options);
During execution, the assertView command calls waitForExist with waitTimeout and waitInterval.
Command Parameters
| Name | Type | Description |
| state | String | Required parameter. The name of the test state. It must be unique within a single test. |
| options | Object | Settings for the assertView command. |
state
Required parameter. Specifies the name of the test state. The name must be unique within a single test.
options
Specifies the settings for the assertView command:
| Option | Type | Description |
| ignoreElements | Array or String | Elements (specified as selectors) that will be ignored when comparing screenshots. Ignoring is implemented by painting the listed elements black. In the case of a single element, the parameter can be specified as a string. |
| tolerance | Number | Sensitivity to color differences. |
| antialiasingTolerance | Number | Sensitivity to antialiasing. |
| allowViewportOverflow | Boolean | By default, Testplane throws an error if an element is outside the viewport boundaries. This parameter disables boundary checking, allowing screenshots of elements that do not fit within the viewport. Only the parts of the element that fit within the viewport will be visible in the screenshot. However, if compositeImage is set to true, parts of the element that are below the viewport will also be visible in the screenshot. Similarly, if captureElementFromTop is set to true, parts of the element that are above the viewport will also be included in the screenshot. |
| captureElementFromTop | Boolean | Capture a screenshot of the element from the very top. If the element is outside the viewport, it will be scrolled into view. |
| compositeImage | Boolean | If the element does not fit within the viewport, enabling this option will take multiple screenshots of different parts of the element sequentially, and then stitch them together into one image to display the entire element. |
| screenshotDelay | Number | Delay in milliseconds before taking a screenshot. This can be useful when there are elements on the page that use animation, or a scrollbar that does not disappear immediately and ends up in the resulting screenshot. |
| selectorToScroll | String | Selector to scroll. This can be useful when you need to take a screenshot of a modal window that does not fit on the screen. Otherwise, without specifying the selector, the scroll will be applied to the window object, and the background will scroll, leaving the popup window in place. |
| disableAnimation | Boolean | Disable animations and transitions when taking a screenshot. Default is |
| ignoreDiffPixelCount | `${number}%` or Number | Percentage of pixels to ignore in the diff. Useful for ignoring very small diffs.
Default is |
Usage Examples
example.js
it("should assert view", async ({ browser }) => {
await browser.url("some/url");
const elem = await browser.$(".button");
await elem.assertView("plain");
await elem.click();
await elem.assertView("clicked");
});