Class UiComponentAbstract

constructor

• new UiComponent(options): UiComponent

• Parameters

  • options: UiComponentOptions

  Returns UiComponent

Readonly aftCfg

Readonly reporter

Abstract driver

• get driver(): unknown

• the top-level interface between the application DOM and the code. for operations within the scope of this UiComponent the getRoot function should be used instead

  Returns unknown

Abstract locator

• get locator(): unknown

• the itentifier used to locate this component's root

  Returns unknown

Abstract parent

• get parent(): Func<void, Promise<unknown>>

• a function returning the view node object that encapsulates this UiComponent. the parent can be used to chain a scoped lookup refresh back to the root of the view preventing stale nodes

  Returns Func<void, Promise<unknown>>

getComponent

• getComponent<F>(componentType, options?): F

• creates a new UiComponent instance of the specified type passing in the driver, aftConfig, reporter and () => this.getRoot() as parent

  Type Parameters

  • F extends UiComponent

  Parameters

  • componentType: Class<F>

    a class extending from UiComponent providing a Page Object Model interface with the DOM

  • Optional options: Partial<UiComponentOptions>

    an object allowing for overrides to the default driver, locator, parent, reporter and aftConfig objects

  Returns F

  an instance of the specified UiComponent class

Abstract getRoot

• getRoot(): Promise<unknown>

• returns the root view node object identified by this component's locator. the root node should be used to compartmentalise DOM lookups to a scope only within this UiComponent.

  NOTE:

  implementations should resemble the following:

  override async getRoot(): Promise<WebElement> {
     const searchContext = (this.parent != null) ? await this.parent() : this.driver;
     return searchContext.findElement(this.locator);
  }
  Copy

  to ensure a fresh lookup of the root and child elements

  Returns Promise<unknown>