Class OptionsFilter

A model for a Filter component with filter type 'Options' (dropdown).

Hierarchy

Constructors

constructor

Properties

clearButton label root value xpath

Accessors

filterTypeValidator

Methods

activate getChildOfType getGlobalLocator getLocator setValue setValueByLabel verifyFilterType

Constructors

constructor

  • A model for a filter component.

    Parameters

    • parent: ComponentModel | Page | FrameLocator

      The parent playwright page, frame or component model.

    • xpath: string = '//*[starts-with(@data-test-id, "filter:")]'

      A relative xpath selector to this element from the parent.

    • nth: number = 1

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

    Returns OptionsFilter

Properties

Readonly clearButton

clearButton: Locator = ...

A locator to the button which clears the filter.

Readonly label

label: Locator = ...

A locator to the filter label.

Protected root

root: Page | FrameLocator

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

Readonly value

value: Locator = ...

A locator to the element with the selected value.

Readonly xpath

xpath: string

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

Accessors

Protected filterTypeValidator

  • get filterTypeValidator(): string

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

    Returns string

Methods

Protected activate

  • This method expands the filter for input.

    Returns Promise<void>

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

Protected getGlobalLocator

  • 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

  • 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

setValue

  • This method performs actions:

    • Verify the filter type
    • Activate the filter
    • Find a filter option by value, and select it

    Parameters

    • value: string

    Returns Promise<void>

setValueByLabel

  • This method performs actions:

    • Verify the filter type
    • Activate the filter
    • Find a filter option by its label, and select it

    Parameters

    • label: string

    Returns Promise<void>

verifyFilterType

  • This method verifies that the filter 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