frames property

Class: CheckSettingsPlainPlatform: NightwatchLanguage: JavaScript SDK:

Define the full frame hierarchy to the direct parent frame of the HTML element to be checked.

Syntax

eyes.check({ frames: value });

Type:

(
  | {
      frame: Element | Selector | string | number;
      scrollRootElement?: Element | Selector;
    }
  | Element
  | Selector
  | string
  | number
)[];

Type definitions

Element: Used to identify an HTML element defined as |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector: Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'string'}|string|{selector:string;type:string}.

An array of frame elements or frame selectors, as defined by the type, that represent the top to bottom hierarchy of frames to the frame that encloses the region or element to be checked.