Axinom Mosaic Libraries
    Preparing search index...

    A model for Hub component. Use this model for the tiles on the settings page.

    Hierarchy (View Summary)

    Index

    Constructors

    • A model for hub component. Use this model for the tiles on the settings page.

      Parameters

      • parent: Page | FrameLocator

        The playwright page or frame.

      • xpath: string = '//*[@data-test-id="hub"]'

        An absolute XPath selector to this element. Default: '//*[@data-test-id="hub"]'

      Returns Hub

    Properties

    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

      • Optionalxpath: string

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

      • Optionalnth: number

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

      Returns TModel

    • 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

    • This method gets a hub group by position. Position is 1 indexed. Negative numbers count from the end. A hub group is a row of tiles with a label.

      Parameters

      • position: number

      Returns HubGroup

    • This method gets a hub group by label. The text of the label must match exactly.

      Parameters

      • label: string

      Returns HubGroup

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

      • Optionalnth: number

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

      Returns Locator

    • This method gets a tile by Label. The tile can be in any hub group. The label must match exactly. If multiple tiles share the same label, the 'nth' parameter can be used to select which is returned (the first by default).

      Parameters

      • label: string
      • nth: number = 1

      Returns Locator

    • This method gets a tile by URL. The tile can be in any hub group. The URL must match exactly.

      Parameters

      • url: string

      Returns Locator