Interface: UI5Selector

Defined in: src/core/types/selectors.ts:29

UI5 control selector — the primary type for control discovery.

Remarks

All selector fields are optional; at least one must be provided for a valid query. The ancestor and descendant fields are recursive for hierarchical matching.

Example

import type { UI5Selector } from '#core/types/selectors.js';

const selector: UI5Selector = {
  controlType: 'sap.m.Button',
  properties: { text: 'Save' },
};

Properties

ancestor?

readonly optional ancestor: UI5Selector

Defined in: src/core/types/selectors.ts:45

Recursive ancestor selector — control must be inside a matching ancestor.

---

bindingPath?

readonly optional bindingPath: Readonly<Record<string, string>>

Defined in: src/core/types/selectors.ts:41

OData binding path matchers for data-bound controls.

---

controlType?

readonly optional controlType: string

Defined in: src/core/types/selectors.ts:31

UI5 fully qualified control type, e.g., 'sap.m.Button'.

---

descendant?

readonly optional descendant: UI5Selector

Defined in: src/core/types/selectors.ts:47

Recursive descendant selector — control must contain a matching descendant.

---

i18NText?

readonly optional i18NText: Readonly<Record<string, string>>

Defined in: src/core/types/selectors.ts:43

i18n text matchers (property name to expected translated value).

---

id?

readonly optional id: string | RegExp

Defined in: src/core/types/selectors.ts:33

Control ID or RegExp pattern for ID matching.

---

interaction?

readonly optional interaction: UI5Interaction

Defined in: src/core/types/selectors.ts:49

Sub-control interaction target (idSuffix, domChildWith).

---

properties?

readonly optional properties: Readonly<Record<string, unknown>>

Defined in: src/core/types/selectors.ts:39

Key-value property matchers evaluated against control.getProperty().

---

searchOpenDialogs?

readonly optional searchOpenDialogs: boolean

Defined in: src/core/types/selectors.ts:51

When true, also searches controls inside open dialogs/popovers.

---

viewId?

readonly optional viewId: string

Defined in: src/core/types/selectors.ts:37

Owning view ID for scoped discovery.

---

viewName?

readonly optional viewName: string

Defined in: src/core/types/selectors.ts:35

Owning view name for scoped discovery.