accessibilityRegions property

Class: CheckSettingsPlainPlatform: NightwatchLanguage: JavaScript SDK:

Define multiple accessibility regions and their types.

For more information about the Contrast advisor feature see Contrast advisor.

Syntax

eyes.check({ accessibilityRegions: value });

Type:

(
  | {
      region: RegionPlain | Element | Selector;
      type?:
        | AccessibilityRegionType
        | "BoldText"
        | "GraphicalObject"
        | "IgnoreContrast"
        | "LargeText"
        | "RegularText";
    }
  | RegionPlain
  | Element
  | Selector
)[];

Type definitions

RegionPlain
Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
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}.
RegionPlain
Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
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}.