Vscode: Add suggestions for key binding when clause contexts

Created on 14 Jul 2016 · 8Comments · Source: microsoft/vscode

When the user is creating custom keybindings, we now have suggestions (IntelliSense) for command ids.

Suggestions for then when clause contexts (ex, editorFocus, inDebugMode, etc) would also be useful.

context-keys feature-request keybindings-editor

Source

gregvanl

👍61

Most helpful comment

It would still probably be better than no suggestions.

usernamehw on 31 Dec 2018

👍3

All 8 comments

Suggestion for new when clause contexts: contexts related to the source control viewlet. e.g. sourceControlViewletFocus, souceControlInputBoxFocus, sourceControlFilesStaged, etc.

alexanderluchs on 12 Sep 2017

@alexandrudima is there a central place where all the contexts are known so we inject this into the schema? If yes could you provide a code pointer, somebody might want to do a PR. Maybe @gregvanl

isidorn on 13 Mar 2018

👍2

@isidorn No, at this time, keybindings are contributed at runtime from various parts of our system...

alexdima on 29 Mar 2018

Would it be possible to add a 'when clause' that checks the name of currently active integrated terminal? That would make it so much easier to implement specific functionality for different types of terminal usage.

vasselai on 31 Dec 2018

@alexandrudima, Is it possible to inject them as simple text?

Some of the context keys

editorFocus
textInputFocus
editorReadonly
editorHasSelection
editorHasMultipleSelections
editorTabMovesFocus
isInEmbeddedEditor
canUndo
canRedo
editorLangId
editorHasCompletionItemProvider
editorHasCodeActionsProvider
editorHasCodeLensProvider
editorHasDefinitionProvider
editorHasDeclarationProvider
editorHasImplementationProvider
editorHasTypeDefinitionProvider
editorHasHoverProvider
editorHasDocumentHighlightProvider
editorHasDocumentSymbolProvider
editorHasReferenceProvider
editorHasRenameProvider
editorHasDocumentFormattingProvider
editorHasDocumentSelectionFormattingProvider
editorHasSignatureHelpProvider

supportedCodeAction

findWidgetVisible
findInputFocussed
replaceInputFocussed

markersNavigationVisible

messageVisible

parameterHintsVisible
parameterHintsMultipleSignatures

inReferenceSearchEditor

referenceSearchVisible
referenceSearchTreeFocused

renameInputVisible

inSnippetMode
hasNextTabstop
hasPrevTabstop
hasSnippetCompletions

suggestWidgetVisible
suggestWidgetMultipleSuggestions
suggestionMakesTextEdit
acceptSuggestionOnEnter

hasOtherSuggestions

atEndOfWord

hasWordHighlights

accessibilityHelpWidgetVisible

listFocus
listSupportsMultiselect
listHasSelectionOrFocus
listDoubleSelection
listMultiSelection

historyNavigationEnabled

inputFocus

isMac
isLinux
isWindows

breadcrumbsPossible
breadcrumbsVisible
breadcrumbsActive

notificationFocus
notificationCenterVisible
notificationToastsVisible

activePanel
panelFocus

inQuickOpen

sidebarVisible
sideBarFocus
activeViewlet

activeEditor
editorIsOpen
groupActiveEditorDirty
textCompareEditorVisible
textCompareEditorActive
activeEditorGroupEmpty
multipleEditorGroups
inZenMode
splitEditorsVertically

resourceScheme
resourceFilename
resourceLangId
resource
resourceExtname
resourceSet
isFileSystemResource
isFileSystemResourceOrUntitled

workbenchState
workspaceFolderCount

multiCursorModifier

reviewPanelVisible

debugType
debugConfigurationType
debugState
inDebugMode
inDebugRepl
breakpointWidgetVisible
inBreakpointWidget
breakpointsFocused
watchExpressionsFocused
variablesFocused
expressionSelected
breakpointSelected
callStackItemType
loadedScriptsSupported
loadedScriptsItemType

workspaceRecommendations
workspaceFolderRecommendations
addToWorkspaceRecommendations
addToWorkspaceFolderRecommendations

nonEmptyWorkspace
searchExtensions
hasInstalledExtensions
searchBuiltInExtensions
recommendedExtensions
defaultRecommendedExtensions
groupByServersContext

profileSessionState
extensionHostProfileRecorded

explorerViewletVisible
filesExplorerFocus
openEditorsVisible
openEditorsFocus
explorerViewletFocus
explorerResourceIsFolder
explorerResourceReadonly
explorerResourceIsRoot

fileCopied

groupFocusedInOpenEditors
dirtyEditor
resourceSelectedForCompare

saveConflictResolutionContext

problemsViewFocus
problemFocus
problemsFilterFocus
relatedInformationFocus

outlineFiltered
outlineFocused

inOutput
activeLogOutput

inSettingsEditor
inSettingsJSONEditor
inSettingsSearch
settingsTocRowFocus
inKeybindings
inKeybindingsSearch
keybindingFocus

dirtyDiffVisible

searchViewletVisible
searchViewletFocus
inputBoxFocus
searchInputBoxFocus
replaceInputBoxFocus
patternIncludesInputBoxFocus
patternExcludesInputBoxFocus
replaceActive
hasSearchResult
firstMatchFocus
fileMatchOrMatchFocus
fileMatchOrFolderMatchFocus
fileMatchFocus
folderMatchFocus
matchFocus

taskRunning

terminalIsOpen
terminalFocus
terminalTextSelected
terminalFindWidgetVisible
terminalFindWidgetInputFocused
terminalFindWidgetFocused

webviewFindWidgetVisible

interfaceOverviewVisible

interactivePlaygroundFocus

canNavigateBack
canNavigateForward

usernamehw on 31 Dec 2018

@usernamehw if we had a hard coded list of context keys it would be easy to add them.
However having a hard coded list has the down side that we have to manage that list, and it might easily get out of sync with reality

isidorn on 31 Dec 2018

It would still probably be better than no suggestions.

usernamehw on 31 Dec 2018

👍3

Is this still a possibility?