visualDiff

For CLI runs, create or update the baseline with momentic run --update-golden-files. The CLI stores generated baselines under goldenFileDir (default: golden/visual-diff under the project root). A normal run fails if the baseline is missing. Subsequent runs compare the current screenshot against the baseline and fail when the difference exceeds threshold. The bare form - visualDiff compares the full viewport. Use on or css to compare an element; coordinate targets are not supported.

Parameters

Parameter	Type	Required	Description
`on`	`string`	No	Description of the element to diff against.
`css`	`string`	No	CSS selector for the target. Use instead of the description key.
`force`	`boolean`	No	Force the action even when the element is not actionable.
`iframe`	`string`	No	URL or URL pattern of the iframe that contains the target element.
`screenshot`	`{ data, width, height }`	No	Baseline JPEG path or HTTPS URL and its pixel dimensions. Generated baselines use the configured golden directory.
`threshold`	`number`	No	Maximum allowed difference as a fraction. Defaults to `0.1` (10%).
`saveAs`	`string`	No	Name of the variable to write this step’s return value to.
`retries`	`number`	No	Number of times to retry the step on failure before failing the test.
`skipped`	`boolean`	No	Skip this step at execution time.

Shorthand

Bare command. Diffs the full viewport.

- visualDiff

Examples

- visualDiff:
    threshold: 0.1

- visualDiff:
    on: the 'Start HTTP upload' button
    threshold: 0.4
    screenshot:
      data: momentic/tests/visual-diff/golden/upload-button.jpg
      width: 125
      height: 20

- visualDiff:
    threshold: 0.1
    screenshot:
      data: https://example.com/golden/home.jpg
      width: 1920
      height: 1080

Web

Mobile

Parameters

Shorthand

Examples

​Parameters

​Shorthand

​Examples

​Related

Parameters

Shorthand

Examples

Related