Class InputBox

Plain input box variation of the input page object

Hierarchy (view full)

Properties

backButton$ backButton$$ elem$ elem$$ input$ input$$ inputBox$ inputBox$$ message$ message$$ progress$ progress$$ quickList$ quickList$$ quickPickDescription$ quickPickDescription$$ quickPickIndex$ quickPickIndex$$ quickPickLabel$ quickPickLabel$$ quickPickPosition$ quickPickPosition$$ quickPickSelectAll$ quickPickSelectAll$$ row$ row$$ rows$ rows$$ title$ title$$ titleBar$ titleBar$$

Accessors

elem locators parent

Methods

back cancel clear confirm findQuickPick getMessage getPlaceHolder getQuickPicks getText getTitle hasError hasProgress isPassword poll selectQuickPick setText toggleAllQuickPicks wait

Properties

backButton$

backButton$: ChainablePromiseElement<Element>

backButton$$

backButton$$: ChainablePromiseArray<Element[]>

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

input$

input$: ChainablePromiseElement<Element>

input$$

input$$: ChainablePromiseArray<Element[]>

inputBox$

inputBox$: ChainablePromiseElement<Element>

inputBox$$

inputBox$$: ChainablePromiseArray<Element[]>

message$

message$: ChainablePromiseElement<Element>

message$$

message$$: ChainablePromiseArray<Element[]>

progress$

progress$: ChainablePromiseElement<Element>

progress$$

progress$$: ChainablePromiseArray<Element[]>

quickList$

quickList$: ChainablePromiseElement<Element>

quickList$$

quickList$$: ChainablePromiseArray<Element[]>

quickPickDescription$

quickPickDescription$: ChainablePromiseElement<Element>

quickPickDescription$$

quickPickDescription$$: ChainablePromiseArray<Element[]>

quickPickIndex$

quickPickIndex$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

quickPickIndex$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

quickPickLabel$

quickPickLabel$: ChainablePromiseElement<Element>

quickPickLabel$$

quickPickLabel$$: ChainablePromiseArray<Element[]>

quickPickPosition$

quickPickPosition$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

quickPickPosition$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

quickPickSelectAll$

quickPickSelectAll$: ChainablePromiseElement<Element>

quickPickSelectAll$$

quickPickSelectAll$$: ChainablePromiseArray<Element[]>

row$

row$: ChainablePromiseElement<Element>

row$$

row$$: ChainablePromiseArray<Element[]>

rows$

rows$: ChainablePromiseElement<Element>

rows$$

rows$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

titleBar$

titleBar$: ChainablePromiseElement<Element>

titleBar$$

titleBar$$: ChainablePromiseArray<Element[]>

Accessors

elem

  • get elem(): ChainablePromiseElement<Element>

  • Base element of given page object

    Returns ChainablePromiseElement<Element>

locators

parent

  • get parent(): ChainablePromiseElement<Element>

  • Parent element of given page object

    Returns ChainablePromiseElement<Element>

Methods

back

  • back(): Promise<boolean>

  • Click on the back button if it exists

    Returns Promise<boolean>

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

cancel

clear

confirm

findQuickPick

  • findQuickPick(indexOrText): Promise<undefined | QuickPickItem>

  • 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

getMessage

getPlaceHolder

getQuickPicks

getText

getTitle

  • getTitle(): Promise<undefined | string>

  • 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

hasError

  • hasError(): Promise<boolean>

  • Find whether the input is showing an error

    Returns Promise<boolean>

    Promise resolving to notification message

hasProgress

isPassword

  • isPassword(): Promise<boolean>

  • Check if the input field is masked (input type password)

    Returns Promise<boolean>

    Promise resolving to notification message

poll

  • poll(timeout?, interval?): Promise<InputBox>

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

    thenable self reference

selectQuickPick

  • selectQuickPick(indexOrText): Promise<void>

  • 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

setText

  • setText(text): Promise<void>

  • 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

toggleAllQuickPicks

  • toggleAllQuickPicks(state): Promise<void>

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc