Class SelectField

A locator to the select element (..).

Readonlyxpath

xpath: string

An absolute xpath to the DOM element that this component model represents.

Accessors

ProtectedfieldTypeValidator

• get fieldTypeValidator(): string

  A selector which will match the field if the element type is correct.

  Returns string

Methods

getChildOfType

• getChildOfType<TModel extends ComponentModel>(
      model: ComponentModelType<TModel>,
      xpath?: string,
      nth?: number,
  ): TModel

  This method gets a child component model with a provided type. This is useful for modelling a page where the UI is composed in a custom manner.

  Type Parameters

  • TModel extends ComponentModel

  Parameters

  • model: ComponentModelType<TModel>

    A ComponentModel type. e.g. ToggleButton / Modal

  • Optionalxpath: string

    An optional xpath relative to this component. If not provided, the model's default xpath will be used.

  • Optionalnth: number

    Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

  Returns TModel

ProtectedgetGlobalLocator

• getGlobalLocator(selector: string): Locator

  A helper method to create global locators - This helps with locating globally across the entire DOM, rather than being scoped to the form

  Parameters

  • selector: string

  Returns Locator

getLocator

• getLocator(): Locator

  This method gets a locator to the DOM element represented by this component model.

  Returns Locator

• getLocator(xpath: string, nth?: number): Locator

  This method gets a locator to a DOM element relative to the element represented by this component model.

  Parameters

  • xpath: string

    An xpath relative to this component.

  • Optionalnth: number

    Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

  Returns Locator

getValue

• getValue(): Promise<string | null>

  This method verifies the field type and returns the selected value.

  Returns Promise<string | null>

Protected Readonlyoption

• option(value: string): Locator

  A locator to the select an option from the combobox.

  Parameters

  • value: string

  Returns Locator

setValue

• setValue(value: string): Promise<void>

  This method verifies the field type and sets the selected value.

  Parameters

  • value: string

  Returns Promise<void>

setValueByLabel

• setValueByLabel(label: string): Promise<void>

  This method verifies the field type and sets the selected value by label. The label must match exactly.

  Parameters

  • label: string

  Returns Promise<void>

verifyFieldType

• verifyFieldType(): Promise<void>

  This method verifies that the field is visible, and that the actual element matches the model being used.

  Returns Promise<void>

waitForData

• waitForData(value: string): Promise<void>

  This method waits for those inputs that take time to appear.

  Parameters

  • value: string

  Returns Promise<void>

Settings

Member Visibility

Protected