Editor

Constructors

Constructor

new Editor(container, options?): Editor

Parameters

container

HTMLElement

options?

EditorOptions

Returns

Editor

Methods

addPlugin()

addPlugin(plugin): EditorDisposable

Parameters

plugin

EditorPlugin

Returns

EditorDisposable

applyEdit()

applyEdit(edit, tokens, textSnapshot): void

textSnapshot is the text after edit; a detached view renders it. On a buffer session the edit goes through the session, which supplies its own.

Parameters

Returns

void

attachSession()

attachSession(session, options?): void

Parameters

session

DocumentSession

options?

EditorSessionOptions

Returns

void

authorEdits()

authorEdits(author): EditorDisposable

Parameters

author

DocumentEditAuthor

Returns

EditorDisposable

captureSnapshot()

Call Signature

captureSnapshot(options): DocumentPaintCapture

Parameters

options

scope

"document"

Returns

DocumentPaintCapture

Call Signature

captureSnapshot(options?): any

Parameters

options?

scope

"viewport"

Returns

any

clear()

clear(): void

Returns

void

clearDocument()

clearDocument(): void

Returns

void

closeFind()

closeFind(): boolean

Returns

boolean

cursorRedo()

cursorRedo(): boolean

Returns

boolean

cursorUndo()

cursorUndo(): boolean

Returns the carets, and the view, to where they were before the last caret move.

Returns

boolean

detachSession()

detachSession(): void

Returns

void

dispatchCommand()

dispatchCommand(command, context?): boolean

Parameters

command

EditorAnyCommandId

context?

EditorCommandContext

Returns

boolean

dispose()

dispose(): void

Returns

void

edit()

edit(editOrEdits, options?): void

Parameters

editOrEdits

EditorEditInput

options?

DocumentSessionApplyEditsOptions

Returns

void

findNext()

findNext(): boolean

Returns

boolean

findPrevious()

findPrevious(): boolean

Returns

boolean

focus()

focus(): void

Returns

void

fold()

fold(offset?): boolean

Parameters

offset?

number

Returns

boolean

foldAll()

foldAll(): boolean

Returns

boolean

getBufferSession()

getBufferSession(): EditorBufferSession | null

Returns

EditorBufferSession | null

getCommandDeclarations()

getCommandDeclarations(): readonly (EditorCommandDeclaration<"find" | "insertNewlineAndIndent" | "copy" | "cut" | "paste" | "markdown.indentListItem" | "markdown.outdentListItem" | "lsp.rename.accept" | "lsp.rename.cancel" | "tooltip.hide" | "tooltip.scrollUp" | "tooltip.scrollDown" | "tooltip.pageUp" | "tooltip.pageDown" | "tooltip.scrollStart" | "tooltip.scrollEnd" | "markdown.openLink" | "markdown.bold" | "markdown.italic" | "markdown.strikethrough" | "markdown.code" | "markdown.link" | "markdown.heading" | "markdown.bulletList" | "markdown.orderedList" | "markdown.taskList" | "markdown.toggleTask" | "markdown.quote" | "markdown.codeBlock" | "undo" | "redo" | "jumpBack" | "jumpForward" | "cursorUndo" | "cursorRedo" | "findReplace" | "findNext" | "findPrevious" | "editor.action.goToDefinition" | "editor.action.goToReferences" | "editor.action.peekDefinition" | "editor.action.revealDefinitionAside" | "editor.action.goToImplementation" | "editor.action.goToTypeDefinition" | "editor.action.showHover" | "editor.action.marker.next" | "editor.action.marker.prev" | "merge-conflict.accept.current" | "merge-conflict.accept.incoming" | "merge-conflict.accept.both" | "merge-conflict.accept.selection" | "merge-conflict.accept.all-current" | "merge-conflict.accept.all-incoming" | "merge-conflict.accept.all-both" | "merge-conflict.next" | "merge-conflict.previous" | "merge-conflict.compare" | "closeFind" | "toggleFindCaseSensitive" | "toggleFindWholeWord" | "toggleFindRegex" | "toggleFindInSelection" | "togglePreserveCase" | "replaceOne" | "replaceAll" | "selectAllMatches" | "selectAll" | "editor.action.smartSelect.expand" | "editor.action.smartSelect.shrink" | "addNextOccurrence" | "clearSecondarySelections" | "editor.action.insertCursorAbove" | "editor.action.insertCursorBelow" | "editor.action.selectHighlights" | "editor.action.changeAll" | "editor.action.jumpToBracket" | "editor.action.toggleWordWrap" | "editor.action.toggleTabFocusMode" | "editor.action.formatDocument" | "editor.action.rename" | "editor.action.autoFix" | "editor.action.inlineSuggest.commit" | "editor.action.inlineSuggest.acceptNextWord" | "editor.action.triggerSuggest" | "selectNextSuggestion" | "selectPrevSuggestion" | "selectNextPageSuggestion" | "selectPrevPageSuggestion" | "acceptSelectedSuggestion" | "hideSuggestWidget" | "closeParameterHints" | "showNextParameterHint" | "showPrevParameterHint" | "editor.action.moveSelectionToNextFindMatch" | "editor.fold" | "editor.unfold" | "editor.foldRecursively" | "editor.unfoldRecursively" | "editor.foldAll" | "editor.unfoldAll" | "editor.foldLevel1" | "editor.foldLevel2" | "editor.foldLevel3" | "editor.foldLevel4" | "editor.foldLevel5" | "editor.foldLevel6" | "editor.foldLevel7" | "editor.createFoldingRangeFromSelection" | "editor.removeManualFoldingRanges" | "deleteBackward" | "deleteForward" | "deleteWordLeft" | "deleteWordRight" | "deleteWordPartLeft" | "deleteWordPartRight" | "editor.action.commentLine" | "editor.action.blockComment" | "editor.action.indentLines" | "editor.action.outdentLines" | "editor.action.reindentlines" | "editor.action.reindentselectedlines" | "editor.action.deleteLines" | "editor.action.copyLinesUpAction" | "editor.action.copyLinesDownAction" | "editor.action.moveLinesUpAction" | "editor.action.moveLinesDownAction" | "editor.action.insertLineBefore" | "editor.action.insertLineAfter" | "editor.action.trimTrailingWhitespace" | "editor.action.sortLinesAscending" | "editor.action.sortLinesDescending" | "editor.action.joinLines" | "editor.action.duplicateSelection" | "editor.action.transformToUppercase" | "editor.action.transformToLowercase" | "editor.action.transformToTitlecase" | "cursorWordPartLeft" | "cursorWordPartRight" | "cursorWordPartLeftSelect" | "cursorWordPartRightSelect" | "indentSelection" | "outdentSelection" | "cursorLeft" | "cursorRight" | "cursorUp" | "cursorDown" | "selectLeft" | "selectRight" | "selectUp" | "selectDown" | "cursorWordLeft" | "cursorWordRight" | "selectWordLeft" | "selectWordRight" | "cursorLineStart" | "cursorLineEnd" | "selectLineStart" | "selectLineEnd" | "cursorPageUp" | "cursorPageDown" | "selectPageUp" | "selectPageDown" | "cursorDocumentStart" | "cursorDocumentEnd" | "selectDocumentStart" | "selectDocumentEnd" | "cursorColumnSelectLeft" | "cursorColumnSelectRight" | "cursorColumnSelectUp" | "cursorColumnSelectDown" | "cursorColumnSelectPageUp" | "cursorColumnSelectPageDown"> | EditorContributedCommandDeclaration)[]

The commands this editor knows: every built-in, then those its plugins contribute.

Returns

getContentHeight()

getContentHeight(): number

Returns

number

getFeature()

getFeature<T>(token): T | null

A capability a plugin registered on this editor, such as spellcheck; null while none has.

Type Parameters

T

T

Parameters

token

EditorCapabilityToken<T>

Returns

T | null

getHotkeysHost()

getHotkeysHost(): EditorHotkeysHost

The dispatcher and focus node that own this editor’s keyboard commands.

Returns

EditorHotkeysHost

getInputElement()

getInputElement(): HTMLElement

Returns

HTMLElement

getKeymapContext()

getKeymapContext(): EditorKeymapContext

Returns

EditorKeymapContext

getMergeConflicts()

getMergeConflicts(): readonly MergeConflictRegion[]

Returns

readonly MergeConflictRegion[]

getPresentationState()

getPresentationState(): "provisional" | "live" | "empty"

Returns

"provisional" | "live" | "empty"

getScrollPosition()

getScrollPosition(): Required<EditorScrollPosition>

Returns

Required<EditorScrollPosition>

getSelections()

getSelections(): readonly EditorResolvedSelection[]

Every selection as document offsets, primary first.

Returns

readonly EditorResolvedSelection[]

getState()

getState(): EditorState

Returns

EditorState

getSyntaxRecords()

getSyntaxRecords(): EditorSyntaxRecords | null

Parsed records for this exact text revision; absent while analysis catches up.

Returns

EditorSyntaxRecords | null

getTextSnapshot()

getTextSnapshot(): TextSnapshot

Returns

TextSnapshot

isTabMovesFocusEnabled()

isTabMovesFocusEnabled(): boolean

Returns

boolean

isWordWrapEnabled()

isWordWrapEnabled(): boolean

Returns

boolean

jumpBack()

jumpBack(): boolean

Returns

boolean

jumpForward()

jumpForward(): boolean

Returns

boolean

jumpTo()

jumpTo(anchor, head?, cause?): void

Parameters

anchor

number

head?

number

cause?

JumpCause

Returns

void

markerAtPoint()

markerAtPoint(clientX, clientY): EditorMarkerHit | null

Parameters

clientX

number

clientY

number

Returns

EditorMarkerHit | null

materializeFullText()

materializeFullText(): string

O(document length) on every call, never cached; save and export are what it is for.

Returns

string

onDidChangeContentHeight()

onDidChangeContentHeight(listener): EditorDisposable

Called with the rows’ total height in pixels whenever it changes: lines added or removed, wrap reflowing, the font changing. A host that grows with its text sizes itself from this.

Parameters

listener

(height) => void

Returns

EditorDisposable

onDidScroll()

onDidScroll(listener): EditorDisposable

Called with the position after it changes, from a gesture, a programmatic move or a clamp. The virtualizer has already folded the scroll in, so the position is current, and nothing throttles it.

Parameters

listener

(position) => void

Returns

EditorDisposable

onDidTransaction()

onDidTransaction(listener): EditorDisposable

Each logical edit, before view updates can coalesce it. The registration survives document swaps.

Parameters

listener

(event) => void

Returns

EditorDisposable

openDocument()

openDocument(document): void

Parameters

document

EditorOpenDocumentOptions

Returns

void

openFind()

openFind(): boolean

Returns

boolean

openFindReplace()

openFindReplace(): boolean

Returns

boolean

reconcile()

reconcile(base, batches, options): void

Parameters

base

PieceTableTreeSnapshot

batches

readonly readonly TextEdit[][]

options

DocumentSessionReconcileOptions

Returns

void

registerKeymapNode()

registerKeymapNode(options): object

Parameters

options

EditorKeymapNodeOptions

Returns

object

dispose

dispose: () => void

Returns

void

removePlugin()

removePlugin(plugin): boolean

Parameters

plugin

EditorPlugin

Returns

boolean

replaceAll()

replaceAll(): boolean

Returns

boolean

replaceOne()

replaceOne(): boolean

Returns

boolean

resolveMergeConflict()

resolveMergeConflict(index, resolution): boolean

Parameters

index

number

resolution

MergeConflictResolution

Returns

boolean

revealMergeConflict()

revealMergeConflict(index): boolean

Parameters

index

number

Returns

boolean

rowAtPoint()

rowAtPoint(clientX, clientY): EditorPointHit | null

Parameters

clientX

number

clientY

number

Returns

EditorPointHit | null

runInOperation()

runInOperation<T>(run): T

Runs run as a single mutating pass. Whatever it changes, the caret is revealed once, the DOM selection is written back once and listeners hear once, at the end — so a sequence of edits costs one visual update instead of one each. Calls made from inside a pass join it rather than opening another.

Type Parameters

T

T

Parameters

run

() => T

Returns

T

selectAllMatches()

selectAllMatches(): boolean

Returns

boolean

setContent()

setContent(text): void

On a buffer session this replaces the buffer’s text as one undoable edit every view sees.

Parameters

text

string

Returns

void

setDetectIndentation()

setDetectIndentation(enabled): void

Parameters

enabled

boolean

Returns

void

setDocument()

setDocument(document): void

Parameters

document

EditorDocument

Returns

void

setEditability()

setEditability(editability): void

Parameters

editability

EditorEditability

Returns

void

setFolding()

setFolding(enabled): void

Parameters

enabled

boolean

Returns

void

setFoldMap()

setFoldMap(foldMap): void

Parameters

foldMap

FoldMap | null

Returns

void

setFontFamily()

setFontFamily(fontFamily): void

A CSS font-family list; undefined hands the face back to the stylesheet.

Parameters

fontFamily

string | undefined

Returns

void

setFontSize()

setFontSize(fontSize): void

Undefined hands the size back to the stylesheet.

Parameters

Returns

void

setGutterLeadingInset()

setGutterLeadingInset(inset): void

Empty pixels before the first gutter lane; row decorations tint them. 0 removes the inset.

Parameters

inset

number

Returns

void

setGutterScroll()

setGutterScroll(mode): void

Switch all gutter lanes between the viewport edge and the horizontally scrolling text.

Parameters

mode

NonNullable<EditorGutterScroll | undefined>

Returns

void

setHiddenCharacters()

setHiddenCharacters(mode): void

Parameters

mode

HiddenCharactersMode

Returns

void

setInlineMap()

setInlineMap(inlineMap): void

Installs the inline replacements this document renders instead of parts of its own text — the entry point a markdown live-preview view drives. Passing null restores raw buffer text.

Parameters

inlineMap

InlineMap | null

Returns

void

setInlineReplacementProvider()

setInlineReplacementProvider(provider, options?): void

Registers a provider that turns the document’s syntax captures into inline replacements. The map is rebuilt whenever fresh captures land, so a markdown view stays in step with the parse without the host scheduling anything itself. Passing null removes the transform.

Parameters

provider

EditorInlineReplacementProvider | null

options?

EditorInlineReplacementProviderOptions

Returns

void

setInlineSuggestion()

setInlineSuggestion(edit): boolean

Offers an inline suggestion, drawn in front of the reader as the part of it the document does not already hold. Passing null takes back whatever is showing.

Parameters

edit

TextEdit | null

Returns

boolean

setKeymap()

setKeymap(keymap): void

Parameters

keymap

EditorKeymapOptions | undefined

Returns

void

setLineHeight()

setLineHeight(lineHeight): void

Parameters

lineHeight

number

Returns

void

setPlugins()

setPlugins(plugins): void

Parameters

plugins

readonly EditorPlugin[]

Returns

void

setPresentationReady()

setPresentationReady(ready): void

Parameters

ready

boolean

Returns

void

setRangeDecorations()

setRangeDecorations(decorations): void

Parameters

decorations

readonly EditorRangeDecoration[]

Returns

void

setRowDecorations()

setRowDecorations(decorations): void

Parameters

decorations

ReadonlyMap<number, VirtualizedTextRowDecoration>

Returns

void

setRowGap()

setRowGap(rowGap): void

Parameters

rowGap

number

Returns

void

setScrollMode()

setScrollMode(scrollMode): void

Parameters

scrollMode

VirtualizedTextViewScrollMode | undefined

Returns

void

setScrollPosition()

setScrollPosition(scrollPosition): void

Parameters

scrollPosition

EditorScrollPosition

Returns

void

setSelection()

setSelection(anchor, head?, options?): void

Parameters

anchor

number

head?

number

options?

EditorSetSelectionOptions

Returns

void

setSnapshot()

setSnapshot(snapshot, documentKey): void

Parameters

snapshot

string | null

documentKey

string | null

Returns

void

setSuspiciousCharacters()

setSuspiciousCharacters(options): void

Parameters

options

EditorSuspiciousCharactersOptions | undefined

Returns

void

setSyntaxFolds()

setSyntaxFolds(folds): void

Parameters

folds

readonly FoldRange[]

Returns

void

setTabMovesFocus()

setTabMovesFocus(enabled): boolean

Gives Tab back to the page, or takes it for indentation again. Returns the state in effect afterwards. Nothing is announced from here: a host writing its own controls says what it did in its own words, and the key that toggles this from inside the editor speaks for itself.

Parameters

enabled

boolean

Returns

boolean

setTabSize()

setTabSize(tabSize): void

Columns a tab spans, and the fallback the open document’s indentation is guessed against, so a document that gave no sign of its own follows the new width. Undefined is the default, 4.

Parameters

tabSize

number | undefined

Returns

void

setText()

setText(text, options?): void

Parameters

text

string

options?

EditorSetTextOptions

Returns

void

setTheme()

setTheme(theme): void

Parameters

theme

EditorTheme | null | undefined

Returns

void

setTokens()

setTokens(tokens): void

Parameters

tokens

EditorTokenInput

Returns

void

setWordWrap()

setWordWrap(enabled): boolean

Turns soft wrap on or off. Returns the state actually in effect afterwards.

Parameters

enabled

boolean

Returns

boolean

syncText()

syncText(text, options?): void

Parameters

text

string

options?

EditorSetTextOptions

Returns

void

textOffsetFromPoint()

textOffsetFromPoint(clientX, clientY): number | null

Parameters

clientX

number

clientY

number

Returns

number | null

toggleFold()

toggleFold(offset?): boolean

Parameters

offset?

number

Returns

boolean

unfold()

unfold(offset?): boolean

Parameters

offset?

number

Returns

boolean

unfoldAll()

unfoldAll(): boolean

Returns

boolean