A model for a form with methods to get contained form fields. Use this model for create, form and details stations.

Hierarchy

Constructors

  • A model for a form with methods to get contained form fields.

    Parameters

    • parent: Page | FrameLocator

      The playwright page or frame.

    • Optional xpath: string

      An absolute XPath selector to this element. Default: '//form'

    Returns Form

Properties

modal: Modal

A model for an untyped modal with methods to to apply a model for a specific type. A modal is most often opened from a dynamic data list for data entry.

root: Page | FrameLocator

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

xpath: string

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

Methods

  • 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

  • This method gets a form field by position. Position is 1 indexed. Negative numbers count from the end.

    Parameters

    • position: number

    Returns UntypedFormField

    An untyped form field model with methods to apply a model for a specific field type.

  • This method gets a form field by label. The label text must match exactly.

    Parameters

    • label: string

    Returns UntypedFormField

    An untyped form field model with methods to apply a model for a specific field type.

  • This method gets a form field by property name. The element is matched by looking for a field with a descendent element that has matching name or id attribute.

    Parameters

    • name: string

    Returns UntypedFormField

    An untyped form field model with methods to apply a model for a specific field type.

  • This method gets a form field with a validation error. If multiple form fields have errors, the 'nth' parameter is used to select which is returned (first by default).

    Parameters

    • Optional nth: number

    Returns UntypedFormField

    An untyped form field model with methods to apply a model for a specific field type.

  • 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

  • This method waits for at least one form field to be displayed. As this method does not wait for an event it should not be used inside Promise.all.

    Example usage:

    await app.uiShell.waitForPageTransition(
    list.getRow(1).actionButton.click(),
    );
    await form.waitForData();

    Returns Promise<void>

Generated using TypeDoc