Abstract page object for input fields

Hierarchy (view full)

Properties

backButton$: ChainablePromiseElement<Element>
backButton$$: ChainablePromiseArray<Element[]>
elem$: ChainablePromiseElement<Element>
elem$$: ChainablePromiseArray<Element[]>
input$: ChainablePromiseElement<Element>
input$$: ChainablePromiseArray<Element[]>
inputBox$: ChainablePromiseElement<Element>
inputBox$$: ChainablePromiseArray<Element[]>
message$: ChainablePromiseElement<Element>
message$$: ChainablePromiseArray<Element[]>
progress$: ChainablePromiseElement<Element>
progress$$: ChainablePromiseArray<Element[]>
quickList$: ChainablePromiseElement<Element>
quickList$$: ChainablePromiseArray<Element[]>
quickPickDescription$: ChainablePromiseElement<Element>
quickPickDescription$$: ChainablePromiseArray<Element[]>
quickPickIndex$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [index: number]

      Returns ChainablePromiseElement<Element>

quickPickIndex$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [index: number]

      Returns ChainablePromiseArray<Element[]>

quickPickLabel$: ChainablePromiseElement<Element>
quickPickLabel$$: ChainablePromiseArray<Element[]>
quickPickPosition$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [index: number]

      Returns ChainablePromiseElement<Element>

quickPickPosition$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [index: number]

      Returns ChainablePromiseArray<Element[]>

quickPickSelectAll$: ChainablePromiseElement<Element>
quickPickSelectAll$$: ChainablePromiseArray<Element[]>
row$: ChainablePromiseElement<Element>
row$$: ChainablePromiseArray<Element[]>
rows$: ChainablePromiseElement<Element>
rows$$: ChainablePromiseArray<Element[]>
title$: ChainablePromiseElement<Element>
title$$: ChainablePromiseArray<Element[]>
titleBar$: ChainablePromiseElement<Element>
titleBar$$: ChainablePromiseArray<Element[]>

Accessors

  • get elem(): ChainablePromiseElement<Element>
  • Base element of given page object

    Returns ChainablePromiseElement<Element>

  • get parent(): ChainablePromiseElement<Element>
  • Parent element of given page object

    Returns ChainablePromiseElement<Element>

Methods

  • Click on the back button if it exists

    Returns Promise<boolean>

    Promise resolving to true if a button was clicked, to false otherwise

  • Cancel the input field by pressing Escape

    Returns Promise<void>

    Promise resolving when the input is cancelled

  • Confirm the input field by pressing Enter

    Returns Promise<void>

    Promise resolving when the input is confirmed

  • Scroll through the quick picks to find an item by the name or index

    Parameters

    • indexOrText: string | number

      index (number) or text (string) of the item to search by

    Returns Promise<undefined | QuickPickItem>

    Promise resolvnig to QuickPickItem if found, to undefined otherwise

  • Get the placeholder text for the input field

    Returns Promise<string>

    Promise resolving to input placeholder

  • Get current text of the input field

    Returns Promise<string>

    Promise resolving to text of the input field

  • Retrieve the title of an input box if it has one

    Returns Promise<undefined | string>

    Promise resolving to title if it exists, to undefined otherwise

  • Find whether the input box has an active progress bar

    Returns Promise<boolean>

    Promise resolving to true/false

  • Poll for the element to become visible

    Parameters

    • timeout: number = 10000

      custom timeout for the wait

    • interval: number = 2000

      custom interval to control polling

    Returns Promise<Input>

    thenable self reference

  • Select (click) a quick pick option. Will scroll through the quick picks to find the item. Search for the item can be done by its text, or index in the quick pick menu. Note that scrolling does not affect the item's index, but it will replace some items in the DOM (thus they become unreachable)

    Parameters

    • indexOrText: string | number

      index (number) or text (string) of the item to search by

    Returns Promise<void>

    Promise resolving when the given quick pick is selected

  • Set (by selecting all and typing) text in the input field

    Parameters

    • text: string

      text to set into the input field

    Returns Promise<void>

    Promise resolving when the text is typed in

  • Select/Deselect all quick picks using the 'select all' checkbox If multiple selection is disabled on the input box, no action is performed

    Parameters

    • state: boolean

      true to select all, false to deselect all

    Returns Promise<void>

    Promise resolving when all quick picks have been toggled to desired state

  • Wait for the element to become visible

    Parameters

    • timeout: number = 5000

      custom timeout for the wait

    Returns Promise<Input>

    thenable self reference

Generated using TypeDoc