Class ToggleButtonField

A model for a ToggleButtonField component.

Hierarchy

Constructors

constructor

Properties

button confirmButton error label root xpath

Accessors

fieldTypeValidator

Methods

getChildOfType getLocator isOn toggle verifyFieldType

Constructors

constructor

  • A model for a FormField component.

    Parameters

    • parent: Page | FrameLocator | ComponentModel

      The parent playwright page, frame or component model.

    • Optional xpath: string

      A relative xpath selector to this element from the parent.

    • Optional nth: number

      Position among matching elements. Position is 1 indexed. Negative numbers count from the end.

    Returns ToggleButtonField

Properties

Protected Readonly button

button: Locator

A locator to the button element.

Readonly confirmButton

confirmButton: Locator

A locator to the confirm button which may show after setting a value.

Readonly error

error: Locator

A locator to the field error message.

Readonly label

label: Locator

A locator to the field label.

Protected root

root: Page | FrameLocator

The root playwright entity from which to resolve this component model's xpath.

Readonly xpath

xpath: string

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

Accessors

Protected fieldTypeValidator

  • get fieldTypeValidator(): string

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

    Returns string

Methods

getChildOfType

  • 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

    Parameters

    • model: ComponentModelType<TModel>

      A ComponentModel type. e.g. ToggleButton / Modal

    • Optional xpath: string

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

    • Optional nth: number

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

    Returns TModel

getLocator

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

    Returns 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.

    • Optional nth: number

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

    Returns Locator

isOn

  • This method gets the current state of the button.

    Returns Promise<boolean>

toggle

  • This method toggles the button.

    Returns Promise<void>

verifyFieldType

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

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc