Class TitleBarItem

Page object representing an item of the custom VSCode title bar

Hierarchy (view full)

IPageDecorator<typeof TitleBarLocators>
MenuItem<typeof TitleBarLocators>
- TitleBarItem

Index

Constructors

constructor

new TitleBarItem(locators, ctor, openMenu, label, parentMenu): TitleBarItem
Parameters
- locators: VSCodeLocatorMap
- ctor: Function
- openMenu: ((self) => Promise<void>)
  - - (self): Promise<void>
    - Parameters
      self: TitleBarItem
      Returns Promise<void>
- label: string
- parentMenu: Menu<{
      elem: string;
      itemElement: string;
      itemLabel: string;
      itemNesting: string;
      menubar: string;
      overflowItemConstructor: ((label) => string);
      title: string;
      topLevelItemConstructor: ((label) => string);
  }>
Returns TitleBarItem
Inherited from IPageDecorator<typeof TitleBarLocators>.constructor
- Defined in pageobjects/menu/TitleBar.ts:136

Properties

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

itemElement$

itemElement$: ChainablePromiseElement<Element>

itemElement$$

itemElement$$: ChainablePromiseArray<Element[]>

itemLabel$

itemLabel$: ChainablePromiseElement<Element>

itemLabel$$

itemLabel$$: ChainablePromiseArray<Element[]>

itemNesting$

itemNesting$: ChainablePromiseElement<Element>

itemNesting$$

itemNesting$$: ChainablePromiseArray<Element[]>

label

label: string

menubar$

menubar$: ChainablePromiseElement<Element>

menubar$$

menubar$$: ChainablePromiseArray<Element[]>

overflowItemConstructor$

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

Type declaration

- (...args): ChainablePromiseElement<Element>
- Parameters
  - Rest ...args: [label: string]
  Returns ChainablePromiseElement<Element>

overflowItemConstructor$$

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

Type declaration

- (...args): ChainablePromiseArray<Element[]>
- Parameters
  - Rest ...args: [label: string]
  Returns ChainablePromiseArray<Element[]>

parentMenu

parentMenu: Menu<{
    elem: string;
    itemElement: string;
    itemLabel: string;
    itemNesting: string;
    menubar: string;
    overflowItemConstructor: ((label) => string);
    title: string;
    topLevelItemConstructor: ((label) => string);
}>

Type declaration

elem: string
itemElement: string
itemLabel: string
itemNesting: string
menubar: string
overflowItemConstructor: ((label) => string)
- - (label): string
  - Parameters
    - label: string
    Returns string
title: string
topLevelItemConstructor: ((label) => string)
- - (label): string
  - Parameters
    - label: string
    Returns string

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

topLevelItemConstructor$

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

Type declaration

- (...args): ChainablePromiseElement<Element>
- Parameters
  - Rest ...args: [label: string]
  Returns ChainablePromiseElement<Element>

topLevelItemConstructor$$

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

Type declaration

- (...args): ChainablePromiseArray<Element[]>
- Parameters
  - Rest ...args: [label: string]
  Returns ChainablePromiseArray<Element[]>

Accessors

elem

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

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:133

locators

get locators(): PageLocators
Get the locator map of given page object

Returns PageLocators
- Defined in pageobjects/utils.ts:106

parent

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

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:151

Methods

getLabel

getLabel(): string | Promise<string>
Returns the label of the menu item

Returns string | Promise<string>
Inherited from MenuItem.getLabel
- Defined in pageobjects/menu/MenuItem.ts:35

getParent

getParent(): Menu<{
    elem: string;
    itemElement: string;
    itemLabel: string;
    itemNesting: string;
    menubar: string;
    overflowItemConstructor: ((label) => string);
    title: string;
    topLevelItemConstructor: ((label) => string);
}>
Return the Menu object representing the menu this item belongs to Todo: fix this

Returns Menu<{
    elem: string;
    itemElement: string;
    itemLabel: string;
    itemNesting: string;
    menubar: string;
    overflowItemConstructor: ((label) => string);
    title: string;
    topLevelItemConstructor: ((label) => string);
}>
Inherited from MenuItem.getParent
- Defined in pageobjects/menu/MenuItem.ts:28

poll

poll(timeout?, interval?): Promise<TitleBarItem>
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<TitleBarItem>
thenable self reference
Inherited from MenuItem.poll
- Defined in pageobjects/utils.ts:183

select

select(): Promise<ContextMenu>
Use the given menu item: Opens the submenu if the item has children, otherwise simply click the item.

Returns Promise<ContextMenu>
Menu object representing the submenu if the item has children, void otherwise.
Inherited from MenuItem.select
- Defined in pageobjects/menu/TitleBar.ts:146

wait

wait(timeout?): Promise<TitleBarItem>
Wait for the element to become visible
Parameters
- timeout: number = 5000
  custom timeout for the wait
Returns Promise<TitleBarItem>
thenable self reference
Inherited from MenuItem.wait
- Defined in pageobjects/utils.ts:172

Class TitleBarItem

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

locators: VSCodeLocatorMap

ctor: Function

openMenu: ((self) => Promise<void>)

Parameters

self: TitleBarItem

Returns Promise<void>

label: string

parentMenu: Menu<{ elem: string; itemElement: string; itemLabel: string; itemNesting: string; menubar: string; overflowItemConstructor: ((label) => string); title: string; topLevelItemConstructor: ((label) => string); }>

Returns TitleBarItem

Properties

elem$

elem$$

itemElement$

itemElement$$

itemLabel$

itemLabel$$

itemNesting$

itemNesting$$

label

menubar$

menubar$$

overflowItemConstructor$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseElement<Element>

overflowItemConstructor$$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseArray<Element[]>

parentMenu

Type declaration

elem: string

itemElement: string

itemLabel: string

itemNesting: string

menubar: string

overflowItemConstructor: ((label) => string)

Parameters

label: string

Returns string

title: string

topLevelItemConstructor: ((label) => string)

Parameters

label: string

Returns string

title$

title$$

topLevelItemConstructor$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseElement<Element>

topLevelItemConstructor$$

Type declaration

Parameters

Rest ...args: [label: string]

Returns ChainablePromiseArray<Element[]>

Accessors

elem

Returns ChainablePromiseElement<Element>

locators

Returns PageLocators

parent

Returns ChainablePromiseElement<Element>

Methods

getLabel

Returns string | Promise<string>

getParent

parentMenu: Menu<{
elem: string;
itemElement: string;
itemLabel: string;
itemNesting: string;
menubar: string;
overflowItemConstructor: ((label) => string);
title: string;
topLevelItemConstructor: ((label) => string);
}>

`Rest` ...args: [label: string]

`Rest` ...args: [label: string]

`Rest` ...args: [label: string]

`Rest` ...args: [label: string]

Returns Menu<{
elem: string;
itemElement: string;
itemLabel: string;
itemNesting: string;
menubar: string;
overflowItemConstructor: ((label) => string);
title: string;
topLevelItemConstructor: ((label) => string);
}>