Class KeymapsFrontendContribution

The command contribution should be implemented to register custom commands and handler.

Hierarchy (View Summary)

AbstractViewContribution<KeybindingWidget>
- KeymapsFrontendContribution

Implements

Index

Constructors

constructor

new KeymapsFrontendContribution(): KeymapsFrontendContribution
Returns KeymapsFrontendContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:109

Properties

`Protected` `Readonly`clipboard

clipboard: ClipboardService

`Protected` `Readonly`keymaps

keymaps: KeymapsService

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`shell

shell: ApplicationShell

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

effectiveWidgetId

get effectiveWidgetId(): string
The widget ID used for shell operations — viewContainerId if set, otherwise widgetId.

Returns string
Inherited from AbstractViewContribution.effectiveWidgetId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

Methods

closeView

closeView(): Promise<undefined | KeybindingWidget>
Returns Promise<undefined | KeybindingWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:41

openView

openView(args?: Partial<OpenViewArguments>): Promise<KeybindingWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<KeybindingWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
Overrides AbstractViewContribution.registerCommands
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:119

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:245

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Implementation of MenuContribution.registerMenus
Overrides AbstractViewContribution.registerMenus
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:187

registerToolbarItems

registerToolbarItems(toolbar: TabBarToolbarRegistry): Promise<void>
Registers toolbar items.
Parameters
- toolbar: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns Promise<void>
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:252

toggleView

toggleView(): Promise<KeybindingWidget>
Returns Promise<KeybindingWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:42

tryGetWidget

tryGetWidget(): undefined | KeybindingWidget
Returns undefined | KeybindingWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:38

`Protected`withItem

withItem<T>(
fn: (item: KeybindingItem, ...rest: unknown[]) => T,
...args: unknown[],
): false | T
Type Parameters
- T
Parameters
- fn: (item: KeybindingItem, ...rest: unknown[]) => T
- ...args: unknown[]
Returns false | T
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:280

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
fn: (widget: KeybindingWidget) => T,
): false | T
Determine if the current widget is the keybindings widget.
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- fn: (widget: KeybindingWidget) => T
Returns false | T
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:273

`Protected`withWidgetItem

withWidgetItem<T>(
    fn: (
        item: KeybindingItem,
        widget: KeybindingWidget,
        ...rest: unknown[],
    ) => T,
    ...args: unknown[],
): false | T
Type Parameters
- T
Parameters
- fn: (item: KeybindingItem, widget: KeybindingWidget, ...rest: unknown[]) => T
- ...args: unknown[]
Returns false | T
- Defined in packages/keymaps/src/browser/keymaps-frontend-contribution.ts:288