Class MonacoResolvedKeybinding

Hierarchy

ResolvedKeybinding
- MonacoResolvedKeybinding

Index

Constructors

Properties

Methods

getAriaLabel getChords getDispatchChords getElectronAccelerator getLabel getSingleModifierDispatchChords getSingleModifierDispatchPart getUserSettingsLabel hasMultipleChords isWYSIWYG keyCode keySequence toKeybinding

Constructors

constructor

new MonacoResolvedKeybinding(
keySequence: KeySequence,
keybindingService: KeybindingRegistry,
): MonacoResolvedKeybinding
Parameters
- keySequence: KeySequence
- keybindingService: KeybindingRegistry
Returns MonacoResolvedKeybinding
Overrides ResolvedKeybinding.constructor
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:33

Properties

`Protected` `Readonly`chords

chords: ResolvedChord[]

`Protected` `Readonly`keySequence

keySequence: KeySequence

Methods

getAriaLabel

getAriaLabel(): null | string
This prints the binding in a format suitable for ARIA.

Returns null | string
Overrides ResolvedKeybinding.getAriaLabel
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:54

getChords

getChords(): ResolvedChord[]
Returns the chords that comprise of the keybinding.

Returns ResolvedChord[]
Overrides ResolvedKeybinding.getChords
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:116

getDispatchChords

getDispatchChords(): (null | string)[]
Returns the chords as strings useful for dispatching. Returns null for modifier only chords.

Returns (null | string)[]
Example
```
keybinding "Shift" -> null
```
Example
```
keybinding ("D" with shift == true) -> "shift+D"
```
Overrides ResolvedKeybinding.getDispatchChords
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:79

getElectronAccelerator

getElectronAccelerator(): null | string
This prints the binding in a format suitable for electron's accelerators. See https://github.com/electron/electron/blob/master/docs/api/accelerator.md

Returns null | string
Overrides ResolvedKeybinding.getElectronAccelerator
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:58

getLabel

getLabel(): null | string
This prints the binding in a format suitable for displaying in the UI.

Returns null | string
Overrides ResolvedKeybinding.getLabel
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:50

getSingleModifierDispatchChords

getSingleModifierDispatchChords(): (null | SingleModifierChord)[]
Returns the modifier only chords as strings useful for dispatching. Returns null for chords that contain more than one modifier or a regular key.

Returns (null | SingleModifierChord)[]
Example
```
keybinding "Shift" -> "shift"
```
Example
```
keybinding ("D" with shift == true") -> null
```
Overrides ResolvedKeybinding.getSingleModifierDispatchChords
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:83

`Protected`getSingleModifierDispatchPart

getSingleModifierDispatchPart(code: KeyCode): null | SingleModifierChord
Parameters
- code: KeyCode
Returns null | SingleModifierChord
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:87

getUserSettingsLabel

getUserSettingsLabel(): null | string
This prints the binding in a format suitable for user settings.

Returns null | string
Overrides ResolvedKeybinding.getUserSettingsLabel
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:67

hasMultipleChords

hasMultipleChords(): boolean
Does the keybinding consist of more than one chord?

Returns boolean
Overrides ResolvedKeybinding.hasMultipleChords
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:75

isWYSIWYG

isWYSIWYG(): boolean
Is the user settings label reflecting the label?

Returns boolean
Overrides ResolvedKeybinding.isWYSIWYG
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:71

`Static`keyCode

keyCode(keybinding: Chord): KeyCode
Parameters
- keybinding: Chord
Returns KeyCode
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:124

`Static`keySequence

keySequence(keybinding: Chord[]): KeySequence
Parameters
- keybinding: Chord[]
Returns KeySequence
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:149

`Static`toKeybinding

toKeybinding(keybindings: Chord[]): string
Parameters
- keybindings: Chord[]
Returns string
- Defined in packages/monaco/src/browser/monaco-resolved-keybinding.ts:120

Class MonacoResolvedKeybinding

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MonacoResolvedKeybinding

Properties

Protected Readonlychords

Protected ReadonlykeySequence

Methods

getAriaLabel

Returns null | string

getChords

Returns ResolvedChord[]

getDispatchChords

Returns (null | string)[]

Example

Example

getElectronAccelerator

Returns null | string

getLabel

Returns null | string

getSingleModifierDispatchChords

Returns (null | SingleModifierChord)[]

Example

Example

ProtectedgetSingleModifierDispatchPart

Parameters

Returns null | SingleModifierChord

getUserSettingsLabel

Returns null | string

hasMultipleChords

Returns boolean

isWYSIWYG

Returns boolean

StatickeyCode

Parameters

Returns KeyCode

StatickeySequence

Parameters

Returns KeySequence

StatictoKeybinding

Parameters

Returns string

Settings

On This Page

`Protected` `Readonly`chords

`Protected` `Readonly`keySequence

`Protected`getSingleModifierDispatchPart

`Static`keyCode

`Static`keySequence

`Static`toKeybinding