SidebarTopMenuWidget | Theia TypeDoc

The menu widget placed on the top of the sidebar.

Hierarchy

SidebarMenuWidget
- SidebarTopMenuWidget

Constructors

constructor

new SidebarTopMenuWidget(): SidebarTopMenuWidget

Inherited from SidebarMenuWidget.constructor
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:55
Construct a new widget.

Returns SidebarTopMenuWidget

Properties

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly menus

menus: SidebarMenu[]

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

Protected Readonly onRender

onRender: DisposableCollection = ...

Readonly onScrollUp

onScrollUp: Event<void> = ...

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

Protected preservedContext

preservedContext: undefined | HTMLElement

The element that had focus when a menu rendered by this widget was activated.

Protected preservingContext

preservingContext: boolean = false

Flag indicating whether a context menu is open. While a context menu is open, the preservedContext should not be cleared.

Protected Optional scrollBar

scrollBar?: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions?: Options

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Methods

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from SidebarMenuWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:210
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from SidebarMenuWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:199
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes, action: ((event: KeyboardEvent) => boolean | void | Object), ...additionalEventTypes: K[]): void

Inherited from SidebarMenuWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:203
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes
- action: ((event: KeyboardEvent) => boolean | void | Object)
  - - (event: KeyboardEvent): boolean | void | Object
    - Parameters
      - event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void

addMenu

addMenu(menu: SidebarMenu): void

Inherited from SidebarMenuWidget.addMenu
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:60
Parameters
- menu: SidebarMenu
Returns void

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from SidebarMenuWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:192
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

clearFlag

clearFlag(flag: Flag): void

Inherited from SidebarMenuWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:221
Parameters
- flag: Flag
Returns void

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from SidebarMenuWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:174
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from SidebarMenuWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:117
Returns void

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from SidebarMenuWidget.getScrollContainer
- Defined in packages/core/src/browser/widgets/widget.ts:170
Returns MaybePromise<HTMLElement>

Protected onAfterAttach

onAfterAttach(msg: Message): void

Inherited from SidebarMenuWidget.onAfterAttach
- Defined in packages/core/src/browser/widgets/widget.ts:149
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from SidebarMenuWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:137
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from SidebarMenuWidget.onBeforeAttach
- Defined in packages/core/src/browser/widgets/widget.ts:130
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from SidebarMenuWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:144
Parameters
- msg: Message
Returns void

Protected onClick

onClick(e: MouseEvent<HTMLElement, MouseEvent>, menuPath: MenuPath): void

Inherited from SidebarMenuWidget.onClick
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:94
Parameters
- e: MouseEvent<HTMLElement, MouseEvent>
- menuPath: MenuPath
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from SidebarMenuWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:125
Parameters
- msg: Message
Returns void

Protected Readonly onMouseDown

onMouseDown(): void

Inherited from SidebarMenuWidget.onMouseDown
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:81
Returns void

Protected Readonly onMouseOut

onMouseOut(): void

Inherited from SidebarMenuWidget.onMouseOut
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:88
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Inherited from SidebarMenuWidget.onUpdateRequest
- Defined in packages/core/src/browser/widgets/react-widget.tsx:40
Parameters
- msg: Message
Returns void

removeMenu

removeMenu(menuId: string): void

Inherited from SidebarMenuWidget.removeMenu
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:70
Parameters
- menuId: string
Returns void

Protected render

render(): ReactNode

Inherited from SidebarMenuWidget.render
- Defined in packages/core/src/browser/shell/sidebar-menu-widget.tsx:114
Render the React widget in the DOM.
- If the widget has been previously rendered, any subsequent calls will perform an update and only change the DOM if absolutely necessary.
Returns ReactNode

setFlag

setFlag(flag: Flag): void

Inherited from SidebarMenuWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:214
Parameters
- flag: Flag
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SidebarTopMenuWidget

Properties

Protected Readonly contextMenuRenderer

Protected Readonly menus

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Protected Readonly onRender

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected preservedContext

Protected preservingContext

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Methods

Protected addClipboardListener

Type Parameters

K extends "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes

action: ((event: KeyboardEvent) => boolean | void | Object)

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void

addMenu

Parameters

menu: SidebarMenu

Returns void

Protected addUpdateListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

type: K

Optional useCapture: boolean

Returns void

clearFlag

Parameters

flag: Flag

Returns void

Protected disableScrollBarFocus

Parameters

scrollContainer: HTMLElement

Returns void

dispose

Returns void

Protected getScrollContainer

Returns MaybePromise<HTMLElement>