Text Editor API

Note: The text editor component is being upgraded to support LSP integration. Properties marked with ⚠️ are not yet implemented.

Properties

Name	Type	Description	Default	Status
value	string	The text to display.	''	✅
readOnly	boolean | string	Disable editing. If "nocursor" is provided, focusing the editor is also disabled.	false	✅
keybindings	object	Object containing keybindings where the key is a combination of keys and the value is a function. For example, { 'Ctrl-Enter': function submit(){}, 'Cmd-Enter': function submit(){} }.	undefined	✅
keymap	string	Configure the keymap to use. Possible values are 'default', 'vim', 'emacs' and 'sublime'.	default	✅
lineWrapping	boolean	Enable line wrapping.	false	✅
focus	boolean	Control or observe focus state of the editor.	false	✅
contextMenuItems	array | function	Add custom items to the context menu.	undefined	✅
lineNumbers	boolean	Show line numbers in the editor.	true	✅
lsConfig	LanguageServerConfiguration	Configure the Language Server Protocol integration. See Language Server Configuration below.	undefined	✅
replaceExtensions	Extension[] | (extensions: Extension[]) => Extension[]	Replace or modify the default CodeMirror extensions used by the editor. Accepts either a full list of extensions or a function to transform the default list.	undefined	✅
vimConfig	object	Configure vim mode.	undefined	⚠️
vimKeymaps	array	Configure custom key mappings in vim. See documentation in texteditor/mixin.ts for more details.	undefined	⚠️
foldGutter	boolean	Enable code folding in the editor.	false	⚠️
clipboard	Clipboard	Custom clipboard handler for the editor used in vim. If provided, it must implement a write method to copy text to the clipboard. See MDN Clipboard API for more details.	undefined	⚠️
height	number	[Deprecated] Use CSS to control the editor height instead.	undefined	❌

<!-- Not sure if autofocus should be here, see https://github.com/beekeeper-studio/beekeeper-studio/issues/3051 --> <!-- | `autoFocus` | `boolean` | Automatically focus the editor when it regains window focus after blur. | `false` | ⚠️ | -->

Language Server Configuration

Name	Type	Description	Default
languageId	string	The language identifier (e.g., "javascript", "typescript", "sql").	Required
rootUri	string	The root URI of the workspace.	Required
documentUri	string	The URI of the document being edited.	Required
transport	{ wsUri: string } | WebSocketTransport	Transport config for the language server. Can be a plain object with wsUri, or a WebSocketTransport instance from @open-rpc/client-js.	Required
features	object	Configure which LSP features to enable.	See below
timeout	number	Timeout for LSP requests in milliseconds.	10000

Features Configuration

Name	Type	Description	Default
hoverEnabled	boolean	Enable hover information.	true
completionEnabled	boolean	Enable code completion.	true
diagnosticsEnabled	boolean	Enable diagnostics (errors, warnings).	true
signatureHelpEnabled	boolean	Enable signature help for function calls.	true
semanticTokensEnabled	boolean	Enable semantic token highlighting.	true
definitionEnabled	boolean	Enable go-to-definition.	true
renameEnabled	boolean	Enable rename functionality.	true
codeActionsEnabled	boolean	Enable code actions.	true
signatureActivateOnTyping	boolean	Show signature help while typing.	false

Methods

Name	Description	Arguments
ls()	Returns the Language Server Helpers. See Language Server Helpers for more information.	-

Events

Name	Description	Event Detail
bks-value-change	Emitted when the text is changed.	{ value: string }
bks-initialized	Emitted when the text editor is initialized.	{ editor: TextEditor }
bks-focus	Emitted when the text editor is focused.	{ event: FocusEvent }
bks-blur	Emitted when the text editor is blurred.	{ event: FocusEvent }
bks-lsp-ready	Emitted when the LSP client is ready.	{ capabilities: object }