ui_selector — accessibility selectors

Types used with the accessibility selector API: property matchers, filters, and providers over UiObject nodes.

Table of contents

Enums

• TraversalOrder

Classes

• NotFoundError
• UiSelector

Interfaces

• FindOptions
• PropertyOperator
• SelectorQuery

Types

• PropertyQuery
• PropertyValue
• UiObjectFilter
• UiObjectProvider

Types

PropertyQuery

PropertyQuery: PropertyValue | RegExp

Value (or regex) used on the right-hand side of a selector condition (exact match vs pattern).

PropertyValue

PropertyValue: string | number | boolean

Concrete scalar matched against a node property.

UiObjectFilter

UiObjectFilter: (obj: UiObject) => boolean

Predicate run on each candidate UiObject.

Call signature

( obj ): boolean

Parameters

Name	Type	Description
obj	UiObject	Node under test.

Returns

boolean

Return true to keep the node, false to drop it.

UiObjectProvider

type UiObjectProvider = () => UiObject[] | Promise<UiObject[]>;

See UiObject for the accessibility node type.

Supplies a batch of controls—either a plain array or a Promise of an array—for custom find flows.

Returns

An array of UiObject, or a Promise that resolves to such an array.