Class Section

constructor

• new Section(parent, xpath, nth?): Section

• A model which represents a DOM element.

  Parameters

  • parent: Page | FrameLocator | ComponentModel

    The playwright page object, frame or component model to be used as the parent of this component.

  • xpath: string

    A relative xpath to this component from the parent.

  • Optional nth: number

    Optional position of this component among xpath matches. Position is 1 indexed. Negative numbers count from the end.

  Returns Section

Readonly xpath

getChildOfType

• getChildOfType<TModel>(model, xpath?, nth?): 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<TModel>

  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

getInfoImage

• getInfoImage(position): InfoImage

• This method finds an info image by position. Position is 1 indexed. Negative numbers count from the end.

  Parameters

  • position: number

  Returns InfoImage

getLocator

• getLocator(): Locator

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

  Returns Locator
• getLocator(xpath, nth?): 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

getParagraph

• getParagraph(position): Paragraph

• This method finds a paragraph by position. Position is 1 indexed. Negative numbers count from the end.

  Parameters

  • position: number

  Returns Paragraph

getParagraphByTitle

• getParagraphByTitle(title): Paragraph

• This method finds a paragraph by title. The title must match exactly.

  Parameters

  • title: string

  Returns Paragraph