WebdriverIO SDK reference (@argos-ci/webdriverio)
Reference for @argos-ci/webdriverio: capture screenshots in WebdriverIO tests with argosScreenshot, hide, remove, or mask dynamic elements, and upload them to Argos with the CLI.
WebdriverIO is a Node.js test automation framework for web and mobile applications, built on the WebDriver and WebDriver BiDi protocols. The @argos-ci/webdriverio SDK captures screenshots from your WebdriverIO tests so Argos can detect visual changes on every pull request.
Get started
Follow the WebdriverIO Quickstart to set up Argos with WebdriverIO.
Compatibility
WebdriverIO 6, 7, 8, or 9.
Node.js 22 or later.
API overview
argosScreenshot(browser, name[, options])
browser- AWebdriverIO.Browserinstance.name- The screenshot name; must be unique. If it ends with.png, it is treated as a path.options.hide- Array of WebdriverIO selectors of elements to hide. Hidden elements keep their space in the layout, like withdata-visual-test="transparent". Selectors that match nothing are ignored. More on helpers.options.remove- Array of WebdriverIO selectors of elements to remove. Removed elements no longer take space in the layout, like withdata-visual-test="removed". Selectors that match nothing are ignored. An element in bothhideandremoveis removed.options.mask- Areas to mask when the screenshot is taken, as an array of WebdriverIO selectors or rectangles ({ x, y, width, height }, in pixels of the screenshot). Masked areas are overlaid with a box that completely covers them. Elements withdata-visual-test="blackout"are always masked. Selectors that match nothing are ignored.options.maskColor- The color of the overlay box for masked areas, in CSS color format. Defaults to#FF00FF.options.argosCSS- Specific CSS applied during the screenshot process. More on injecting CSS.
Helper Attributes for Visual Testing
The data-visual-test attributes control how elements appear in Argos screenshots. Use them for elements with dynamic content, like dates.
[data-visual-test="transparent"]: Renders the element transparent (opacity: 0), keeping its layout space.[data-visual-test="removed"]: Removes the element from view (display: none).[data-visual-test="blackout"]: Covers the element with a box inmaskColor.[data-visual-test-no-radius]: Strips the border radius from the element.
Example: Using a helper attribute to hide a div from the captured screenshot:
Example: Using the hide, remove and mask options, without changing the markup:
hide works like transparent, remove like removed, and mask like blackout. Selectors that match nothing are ignored, and an element in both hide and remove is removed. Argos restores the page after the screenshot.
Additional resources
Last updated
Was this helpful?