Class UntypedFormField

A model for a FormElementContainer component with methods to apply a model of a specific field type.

Hierarchy

Constructors

constructor

Properties

as asBooleanViewField asCheckboxField asCustomTagsField asDateTimeField asDynamicDataListField asFileUploadField asGenericField asLinkField asRadioField asReadOnlyField asReadOnlyTextField asSelectField asSingleLineTextField asTagsField asTextAreaField asToggleButtonField content error label root xpath

Methods

getChildOfType getGlobalLocator getLocator

Constructors

constructor

  • A model for a FormField component.

    Parameters

    • parent: ComponentModel | Page | FrameLocator

      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 UntypedFormField

Properties

as

as: (<TField>(type) => TField)

Type declaration

    • <TField>(type): TField

    • This method applies a model to this field.

      Type Parameters

      Parameters

      Returns TField

asBooleanViewField

asBooleanViewField: (() => BooleanViewField)

Type declaration

asCheckboxField

asCheckboxField: (() => CheckboxField)

Type declaration

asCustomTagsField

asCustomTagsField: (() => CustomTagsField)

Type declaration

asDateTimeField

asDateTimeField: (() => DateTimeField)

Type declaration

asDynamicDataListField

asDynamicDataListField: (() => DynamicDataListField)

Type declaration

asFileUploadField

asFileUploadField: (() => FileUploadField)

Type declaration

asGenericField

asGenericField: (() => GenericField)

Type declaration

asLinkField

asLinkField: (() => LinkField)

Type declaration

asRadioField

asRadioField: (() => RadioField)

Type declaration

asReadOnlyField

asReadOnlyField: (() => ReadOnlyField)

Type declaration

asReadOnlyTextField

asReadOnlyTextField: (() => ReadOnlyTextField)

Type declaration

asSelectField

asSelectField: (() => SelectField)

Type declaration

asSingleLineTextField

asSingleLineTextField: (() => SingleLineTextField)

Type declaration

asTagsField

asTagsField: (() => TagsField)

Type declaration

asTextAreaField

asTextAreaField: (() => TextAreaField)

Type declaration

asToggleButtonField

asToggleButtonField: (() => ToggleButtonField)

Type declaration

Readonly content

content: Locator

A locator to the form field content.

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.

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

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc