Class QuickOpenBox

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$$

elem

• get elem(): ChainablePromiseElement<Element>

• Base element of given page object

  Returns ChainablePromiseElement<Element>

locators

• get locators(): PageLocators

• Get the locator map of given page object

  Returns PageLocators

parent

• get parent(): ChainablePromiseElement<Element>

• Parent element of given page object

  Returns ChainablePromiseElement<Element>

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

• cancel(): Promise<void>

• Cancel the input field by pressing Escape

  Returns Promise<void>

  Promise resolving when the input is cancelled

clear

• clear(): Promise<void>

• Clear the input field

  Returns Promise<void>

  Promise resolving when the field is cleared

confirm

• confirm(): Promise<void>

• Confirm the input field by pressing Enter

  Returns Promise<void>

  Promise resolving when the input is confirmed

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

getPlaceHolder

• getPlaceHolder(): Promise<string>

• Get the placeholder text for the input field

  Returns Promise<string>

  Promise resolving to input placeholder

getQuickPicks

• getQuickPicks(): Promise<QuickPickItem[]>

• Retrieve the quick pick items currently available in the DOM (visible in the quick pick menu)

  Returns Promise<QuickPickItem[]>

  Promise resolving to array of QuickPickItem objects

getText

• getText(): Promise<string>

• Get current text of the input field

  Returns Promise<string>

  Promise resolving to text of the input field

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

hasProgress

• hasProgress(): Promise<boolean>

• Find whether the input box has an active progress bar

  Returns Promise<boolean>

  Promise resolving to true/false

poll

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

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

  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

• wait(timeout?): Promise<QuickOpenBox>

• Wait for the element to become visible

  Parameters

  • timeout: number = 5000

    custom timeout for the wait

  Returns Promise<QuickOpenBox>

  thenable self reference