API reference — Applitools Eyes for Storybook

Read first

Follow the Quick Start (install + npx eyes-setup) and Integration with Storybook pages to get a working baseline. Then use this API reference to fine‑tune behavior.

This reference is split across focused pages so you can jump straight to what you need. It covers all options available to the Storybook SDK: CLI flags, environment variables, applitools.config.js properties, browser/device targets (Ultrafast Grid), and per‑story configuration via parameters.eyes.

Where options live

• CLI → one‑off runs (local/CI) and quick filters.
• Environment variables → secrets and CI‑controlled toggles.
• Configuration file: applitools.config.js → the canonical place for project defaults.
• Per‑story config → CSF parameters.eyes or classic .add(…, { eyes }) for story‑specific overrides.

Precedence: Most options can be supplied in any of the three ways. If the same option appears more than once, the typical precedence is: CLI > Env vars > applitools.config.js > Story defaults. Story‑level values override global ones.

Concepts: Baselines, Ultrafast Grid (UFG), and Match Levels are explained in Core Concepts.

---

Pages

1. CLI: eyes-storybook arguments
2. Environment variables
3. Configuration file: applitools.config.js
4. Browsers & devices (Ultrafast Grid)
5. Per‑story configuration (parameters.eyes / .add(..., { eyes }))