Interface IStandaloneEditorConstructionOptions
Expand description
interface IStandaloneEditorConstructionOptions {
acceptSuggestionOnCommitCharacter?: boolean;
acceptSuggestionOnEnter?: "off" | "on" | "smart";
accessibilityHelpUrl?: string;
accessibilityPageSize?: number;
accessibilitySupport?: "off" | "on" | "auto";
allowOverflow?: boolean;
allowVariableFonts?: boolean;
allowVariableFontsInAccessibilityMode?: boolean;
allowVariableLineHeights?: boolean;
ariaContainerElement?: HTMLElement;
ariaLabel?: string;
ariaRequired?: boolean;
autoClosingBrackets?: EditorAutoClosingStrategy;
autoClosingComments?: EditorAutoClosingStrategy;
autoClosingDelete?: EditorAutoClosingEditStrategy;
autoClosingOvertype?: EditorAutoClosingEditStrategy;
autoClosingQuotes?: EditorAutoClosingStrategy;
autoDetectHighContrast?: boolean;
autoIndent?:
| "none"
| "advanced"
| "full"
| "brackets"
| "keep";
autoIndentOnPaste?: boolean;
autoIndentOnPasteWithinString?: boolean;
automaticLayout?: boolean;
autoSurround?: EditorAutoSurroundStrategy;
bracketPairColorization?: IBracketPairColorizationOptions;
codeActionsOnSaveTimeout?: number;
codeLens?: boolean;
codeLensFontFamily?: string;
codeLensFontSize?: number;
colorDecorators?: boolean;
colorDecoratorsActivatedOn?: | "clickAndHover"
| "click"
| "hover";
colorDecoratorsLimit?: number;
columnSelection?: boolean;
comments?: IEditorCommentsOptions;
contextmenu?: boolean;
copyWithSyntaxHighlighting?: boolean;
cursorBlinking?: | "blink"
| "smooth"
| "phase"
| "expand"
| "solid";
cursorHeight?: number;
cursorSmoothCaretAnimation?: "off"
| "on"
| "explicit";
cursorStyle?:
| "line"
| "block"
| "underline"
| "line-thin"
| "block-outline"
| "underline-thin";
cursorSurroundingLines?: number;
cursorSurroundingLinesStyle?: "default"
| "all";
cursorWidth?: number;
defaultColorDecorators?: "auto" | "always" | "never";
definitionLinkOpensInPeek?: boolean;
detectIndentation?: boolean;
dimension?: IDimension;
disableLayerHinting?: boolean;
disableMonospaceOptimizations?: boolean;
domReadOnly?: boolean;
dragAndDrop?: boolean;
dropIntoEditor?: IDropIntoEditorOptions;
editContext?: boolean;
emptySelectionClipboard?: boolean;
experimentalGpuAcceleration?: "off" | "on";
experimentalWhitespaceRendering?:
| "off"
| "svg"
| "font";
extraEditorClassName?: string;
fastScrollSensitivity?: number;
find?: IEditorFindOptions;
fixedOverflowWidgets?: boolean;
folding?: boolean;
foldingHighlight?: boolean;
foldingImportsByDefault?: boolean;
foldingMaximumRegions?: number;
foldingStrategy?: "auto"
| "indentation";
fontFamily?: string;
fontLigatures?: string | boolean;
fontSize?: number;
fontVariations?: string | boolean;
fontWeight?: string;
formatOnPaste?: boolean;
formatOnType?: boolean;
glyphMargin?: boolean;
gotoLocation?: IGotoLocationOptions;
guides?: IGuidesOptions;
hideCursorInOverviewRuler?: boolean;
hover?: IEditorHoverOptions;
inDiffEditor?: boolean;
inertialScroll?: boolean;
inlayHints?: IEditorInlayHintsOptions;
inlineCompletionsAccessibilityVerbose?: boolean;
inlineSuggest?: IInlineSuggestOptions;
insertSpaces?: boolean;
language?: string;
largeFileOptimizations?: boolean;
letterSpacing?: number;
lightbulb?: IEditorLightbulbOptions;
lineDecorationsWidth?: string | number;
lineHeight?: number;
lineNumbers?: LineNumbersType;
lineNumbersMinChars?: number;
linkedEditing?: boolean;
links?: boolean;
matchBrackets?: "always" | "never" | "near";
matchOnWordStartOnly?: boolean;
maxTokenizationLineLength?: number;
minimap?: IEditorMinimapOptions;
model?: ITextModel;
mouseMiddleClickAction?: MouseMiddleClickAction;
mouseStyle?: "default" | "text" | "copy";
mouseWheelScrollSensitivity?: number;
mouseWheelZoom?: boolean;
multiCursorLimit?: number;
multiCursorMergeOverlapping?: boolean;
multiCursorModifier?: "ctrlCmd" | "alt";
multiCursorPaste?: "spread" | "full";
occurrencesHighlight?:
| "off"
| "singleFile"
| "multiFile";
occurrencesHighlightDelay?: number;
overflowWidgetsDomNode?: HTMLElement;
overtypeCursorStyle?: | "line"
| "block"
| "underline"
| "line-thin"
| "block-outline"
| "underline-thin";
overtypeOnPaste?: boolean;
overviewRulerBorder?: boolean;
overviewRulerLanes?: number;
padding?: IEditorPaddingOptions;
parameterHints?: IEditorParameterHintOptions;
pasteAs?: IPasteAsOptions;
peekWidgetDefaultFocus?: "tree"
| "editor";
placeholder?: string;
quickSuggestions?: boolean | IQuickSuggestionsOptions;
quickSuggestionsDelay?: number;
readOnly?: boolean;
readOnlyMessage?: IMarkdownString;
renameOnType?: boolean;
renderControlCharacters?: boolean;
renderFinalNewline?: "off" | "on" | "dimmed";
renderLineHighlight?:
| "all"
| "line"
| "none"
| "gutter";
renderLineHighlightOnlyWhenFocus?: boolean;
renderRichScreenReaderContent?: boolean;
renderValidationDecorations?: "off"
| "on"
| "editable";
renderWhitespace?:
| "all"
| "none"
| "boundary"
| "selection"
| "trailing";
revealHorizontalRightPadding?: number;
roundedSelection?: boolean;
rulers?: (number | IRulerOption)[];
screenReaderAnnounceInlineSuggestion?: boolean;
scrollbar?: IEditorScrollbarOptions;
scrollBeyondLastColumn?: number;
scrollBeyondLastLine?: boolean;
scrollOnMiddleClick?: boolean;
scrollPredominantAxis?: boolean;
selectionClipboard?: boolean;
selectionHighlight?: boolean;
selectionHighlightMaxLength?: number;
selectionHighlightMultiline?: boolean;
selectOnLineNumbers?: boolean;
"semanticHighlighting.enabled"?:
| boolean
| "configuredByTheme";
showDeprecated?: boolean;
showFoldingControls?: "always"
| "never"
| "mouseover";
showUnused?: boolean;
smartSelect?: ISmartSelectOptions;
smoothScrolling?: boolean;
snippetSuggestions?:
| "none"
| "top"
| "bottom"
| "inline";
stablePeek?: boolean;
stickyScroll?: IEditorStickyScrollOptions;
stickyTabStops?: boolean;
stopRenderingLineAfter?: number;
suggest?: ISuggestOptions;
suggestFontSize?: number;
suggestLineHeight?: number;
suggestOnTriggerCharacters?: boolean;
suggestSelection?: | "first"
| "recentlyUsed"
| "recentlyUsedByPrefix";
tabCompletion?: "off"
| "on"
| "onlySnippets";
tabFocusMode?: boolean;
tabIndex?: number;
tabSize?: number;
theme?: string;
trimAutoWhitespace?: boolean;
trimWhitespaceOnDelete?: boolean;
unfoldOnClickAfterEndOfLine?: boolean;
unicodeHighlight?: IUnicodeHighlightOptions;
unusualLineTerminators?: "off" | "auto" | "prompt";
useShadowDOM?: boolean;
useTabStops?: boolean;
value?: string;
wordBasedSuggestions?:
| "off"
| "currentDocument"
| "matchingDocuments"
| "allDocuments";
wordBasedSuggestionsOnlySameLanguage?: boolean;
wordBreak?: "normal"
| "keepAll";
wordSegmenterLocales?: string | string[];
wordSeparators?: string;
wordWrap?: "off" | "on" | "wordWrapColumn" | "bounded";
wordWrapBreakAfterCharacters?: string;
wordWrapBreakBeforeCharacters?: string;
wordWrapColumn?: number;
wordWrapOverride1?: "off" | "on" | "inherit";
wordWrapOverride2?: "off" | "on" | "inherit";
wrapOnEscapedLineFeeds?: boolean;
wrappingIndent?:
| "none"
| "same"
| "indent"
| "deepIndent";
wrappingStrategy?: "simple"
| "advanced";
}Properties§
acceptAccept suggestions on provider defined characters. Defaults to true.
acceptAccept suggestions on ENTER. Defaults to 'on'.
accessibilityAn URL to open when Ctrl+H (Windows and Linux) or Cmd+H (OSX) is pressed in the accessibility help dialog in the editor.
Defaults to "https://go.microsoft.com/fwlink/?linkid=852450"
accessibilityControls the number of lines in the editor that can be read out by a screen reader
accessibilityConfigure the editor's accessibility support. Defaults to 'auto'. It is best to leave this to 'auto'.
allowAllow content widgets and overflow widgets to overflow the editor viewport.
Defaults to true.
allowThis editor is allowed to use variable font-sizes and font-families
allowThis editor is allowed to use variable font-sizes and font-families in accessibility mode
allowThis editor is allowed to use variable line heights.
ariaContainer element to use for ARIA messages. Defaults to document.body.
ariaThe aria label for the editor's textarea (when it is focused).
ariaWhether the aria-required attribute should be set on the editors textarea.
autoOptions for auto closing brackets. Defaults to language defined behavior.
autoOptions for auto closing comments. Defaults to language defined behavior.
autoOptions for pressing backspace near quotes or bracket pairs.
autoOptions for typing over closing quotes or brackets.
autoOptions for auto closing quotes. Defaults to language defined behavior.
autoIf enabled, will automatically change to high contrast theme if the OS is using a high contrast theme. Defaults to true.
autoControls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines. Defaults to advanced.
autoBoolean which controls whether to autoindent on paste
autoBoolean which controls whether to autoindent on paste within a string when autoIndentOnPaste is enabled.
automaticEnable that the editor will install a ResizeObserver to check if its container dom node size has changed. Defaults to false.
autoOptions for auto surrounding. Defaults to always allowing auto surrounding.
bracketConfigures bracket pair colorization (disabled by default).
codeTimeout for running code actions on save.
codeShow code lens Defaults to true.
codeCode lens font family. Defaults to editor font family.
codeCode lens font size. Default to 90% of the editor font size
colorEnable inline color decorators and color picker rendering.
colorControls what is the condition to spawn a color picker from a color dectorator
colorControls the max number of color decorators that can be rendered in an editor at once.
columnEnable that the selection with the mouse and keys is doing column selection. Defaults to false.
comments?: IEditorCommentsOptionsControl the behaviour of comments in the editor.
Enable custom contextmenu. Defaults to true.
copySyntax highlighting is copied.
cursorControl the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'. Defaults to 'blink'.
cursorControl the height of the cursor when cursorStyle is set to 'line'
cursorEnable smooth caret animation. Defaults to 'off'.
cursor
| "line"
| "block"
| "underline"
| "line-thin"
| "block-outline"
| "underline-thin"Control the cursor style in insert mode. Defaults to 'line'.
cursorControls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.
cursorControls when cursorSurroundingLines should be enforced
Defaults to default, cursorSurroundingLines is not enforced when cursor position is changed
by mouse.
cursorControl the width of the cursor when cursorStyle is set to 'line'
defaultControls whether to use default color decorations or not using the default document color provider
definitionControls whether the definition link opens element in the peek widget. Defaults to false.
detectControls whether tabSize and insertSpaces will be automatically detected when a file is opened based on the file contents.
Defaults to true.
dimension?: IDimensionThe initial editor dimension (to avoid measuring the container).
disableDisable the use of transform: translate3d(0px, 0px, 0px) for the editor margin and lines layers.
The usage of transform: translate3d(0px, 0px, 0px) acts as a hint for browsers to create an extra layer.
Defaults to false.
disableDisable the optimizations for monospace fonts. Defaults to false.
domShould the textarea used for input use the DOM readonly attribute.
Defaults to false.
dragControls if the editor should allow to move selections via drag and drop. Defaults to false.
dropControls dropping into the editor from an external source.
When enabled, this shows a preview of the drop location and triggers an onDropIntoEditor event.
editSets whether the new experimental edit context should be used instead of the text area.
emptyCopying without a selection copies the current line.
experimentalEnable experimental rendering using WebGPU. Defaults to 'off'.
experimentalEnable experimental whitespace rendering. Defaults to 'svg'.
extraClass name to be added to the editor.
fastFastScrolling mulitplier speed when pressing Alt
Defaults to 5.
find?: IEditorFindOptionsControl the behavior of the find widget.
fixedDisplay overflow widgets as fixed.
Defaults to false.
folding?: booleanEnable code folding. Defaults to true.
foldingEnable highlight for folded regions. Defaults to true.
foldingAuto fold imports folding regions. Defaults to true.
foldingMaximum number of foldable regions. Defaults to 5000.
foldingSelects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy. Defaults to 'auto'.
fontThe font family
fontEnable font ligatures. Defaults to false.
fontThe font size
fontEnable font variations. Defaults to false.
fontThe font weight
formatEnable format on paste. Defaults to false.
formatEnable format on type. Defaults to false.
glyphEnable the rendering of the glyph margin. Defaults to true in vscode and to false in monaco-editor.
gotoguides?: IGuidesOptionsControls the behavior of editor guides.
hideShould the cursor be hidden in the overview ruler. Defaults to false.
hover?: IEditorHoverOptionsConfigure the editor's hover.
inThis editor is used inside a diff editor.
inertialMake scrolling inertial - mostly useful with touchpad on linux.
inlayControl the behavior and rendering of the inline hints.
inlineControls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.
inline§insertInsert spaces when pressing Tab.
This setting is overridden based on the file contents when detectIndentation is on.
Defaults to true.
language?: stringThe initial language of the auto created model in the editor.
To not automatically create a model, use model: null.
largeSpecial handling for large files to disable certain memory intensive features. Defaults to true.
letterThe letter spacing
lightbulb?: IEditorLightbulbOptionsControl the behavior and rendering of the code action lightbulb.
lineThe width reserved for line decorations (in px). Line decorations are placed between line numbers and the editor content. You can pass in a string in the format floating point followed by "ch". e.g. 1.3ch. Defaults to 10.
lineThe line height
lineControl the rendering of line numbers.
If it is a function, it will be invoked when rendering a line number and the return value will be rendered.
Otherwise, if it is a truthy, line numbers will be rendered normally (equivalent of using an identity function).
Otherwise, line numbers will not be rendered.
Defaults to on.
lineControl the width of line numbers, by reserving horizontal space for rendering at least an amount of digits. Defaults to 5.
linkedEnable linked editing. Defaults to false.
links?: booleanEnable detecting links and making them clickable. Defaults to true.
matchEnable highlighting of matching brackets. Defaults to 'always'.
matchControls whether suggestions allow matches in the middle of the word instead of only at the beginning
maxLines above this length will not be tokenized for performance reasons. Defaults to 20000.
minimap?: IEditorMinimapOptionsControl the behavior and rendering of the minimap.
model?: ITextModelThe initial model associated with this code editor.
mouseEnables middle mouse button to open links and Go To Definition
mouseControl the mouse pointer style, either 'text' or 'default' or 'copy' Defaults to 'text'
mouseA multiplier to be used on the deltaX and deltaY of mouse wheel scroll events.
Defaults to 1.
mouseZoom the font in the editor when using the mouse wheel in combination with holding Ctrl. Defaults to false.
multiControls the max number of text cursors that can be in an active editor at once.
multiMerge overlapping selections. Defaults to true
multiThe modifier to be used to add multiple cursors with the mouse. Defaults to 'alt'
multiConfigure the behaviour when pasting a text with the line count equal to the cursor count. Defaults to 'spread'.
occurrencesEnable semantic occurrences highlight. Defaults to 'singleFile'. 'off' disables occurrence highlighting 'singleFile' triggers occurrence highlighting in the current document 'multiFile' triggers occurrence highlighting across valid open documents
occurrencesControls delay for occurrences highlighting Defaults to 250. Minimum value is 0 Maximum value is 2000
overflowPlace overflow widgets inside an external DOM node. Defaults to an internal DOM node.
overtype
| "line"
| "block"
| "underline"
| "line-thin"
| "block-outline"
| "underline-thin"Control the cursor style in overtype mode. Defaults to 'block'.
overtypeControls whether paste in overtype mode should overwrite or insert.
overviewControls if a border should be drawn around the overview ruler.
Defaults to true.
overviewThe number of vertical lanes the overview ruler should render. Defaults to 3.
padding?: IEditorPaddingOptionsControls the spacing around the editor.
parameterParameter hint options.
pasteControls support for changing how content is pasted into the editor.
peekControls whether to focus the inline editor in the peek widget by default. Defaults to false.
placeholder?: stringSets a placeholder for the editor. If set, the placeholder is shown if the editor is empty.
quickEnable quick suggestions (shadow suggestions) Defaults to true.
quickQuick suggestions show delay (in ms) Defaults to 10 (ms)
readShould the editor be read only. See also domReadOnly.
Defaults to false.
readThe message to display when the editor is readonly.
renamedeprecated, use linkedEditing instead
renderEnable rendering of control characters. Defaults to true.
renderRender last line number when the file ends with a newline. Defaults to 'on' for Windows and macOS and 'dimmed' for Linux.
renderEnable rendering of current line highlight. Defaults to all.
renderControl if the current line highlight should be rendered only the editor is focused. Defaults to false.
renderControls whether to render rich HTML screen reader content when the EditContext is enabled
renderShould the editor render validation decorations. Defaults to editable.
renderEnable rendering of whitespace. Defaults to 'selection'.
revealWhen revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle. This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport. Defaults to 30 (px).
roundedRender the editor selection with rounded borders. Defaults to true.
rulers?: (number | IRulerOption)[]Render vertical lines at the specified columns. Defaults to empty array.
screenControl whether a screen reader announces inline suggestion content immediately.
scrollbar?: IEditorScrollbarOptionsControl the behavior and rendering of the scrollbars.
scrollEnable that scrolling can go beyond the last column by a number of columns. Defaults to 5.
scrollEnable that scrolling can go one screen size after the last line. Defaults to true.
scrollScroll editor on middle click
scrollEnable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad. Defaults to true.
selectionEnable Linux primary clipboard. Defaults to true.
selectionEnable selection highlight. Defaults to true.
selectionMaximum length (in characters) for selection highlights. Set to 0 to have an unlimited length.
selectionEnable selection highlight for multiline selections. Defaults to false.
selectShould the corresponding line be selected when clicking on the line number? Defaults to true.
semanticControls whether the semanticHighlighting is shown for the languages that support it. true: semanticHighlighting is enabled for all themes false: semanticHighlighting is disabled for all themes 'configuredByTheme': semanticHighlighting is controlled by the current color theme's semanticHighlighting setting. Defaults to 'byTheme'.
showControls strikethrough deprecated variables.
showControls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter. Defaults to 'mouseover'.
showControls fading out of unused variables.
smartSmart select options.
smoothEnable that the editor animates scrolling to a position. Defaults to false.
snippetEnable snippet suggestions. Default to 'true'.
stableKeep peek editors open even when double-clicking their content or when hitting Escape.
Defaults to false.
stickyControl the behavior of sticky scroll options
stickyEmulate selection behaviour of tab characters when using spaces for indentation. This means selection will stick to tab stops.
stopPerformance guard: Stop rendering a line after x characters. Defaults to 10000. Use -1 to never stop rendering
suggest?: ISuggestOptionsSuggest options.
suggestThe font size for the suggest widget. Defaults to the editor font size.
suggestThe line height for the suggest widget. Defaults to the editor line height.
suggestEnable the suggestion box to pop-up on trigger characters. Defaults to true.
suggestThe history mode for suggestions.
tabEnable tab completion.
tabControls whether the editor / terminal receives tabs or defers them to the workbench for navigation.
tabThe tabindex property of the editor's textarea
tabThe number of spaces a tab is equal to.
This setting is overridden based on the file contents when detectIndentation is on.
Defaults to 4.
theme?: stringInitial theme to be used for rendering.
The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black', 'hc-light.
You can create custom themes via monaco.editor.defineTheme.
To switch a theme, use monaco.editor.setTheme.
NOTE: The theme might be overwritten if the OS is in high contrast mode, unless autoDetectHighContrast is set to false.
trimRemove trailing auto inserted whitespace. Defaults to true.
trimControls whether the editor should automatically remove indentation whitespace when joining lines with Delete. Defaults to false.
unfoldControls whether clicking on the empty content after a folded line will unfold the line. Defaults to false.
unicodeControls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).
unusualRemove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to 'prompt'.
useControl if the editor should use shadow DOM.
useInserting and deleting whitespace follows tab stops.
value?: stringThe initial value of the auto created model in the editor.
To not automatically create a model, use model: null.
word
| "off"
| "currentDocument"
| "matchingDocuments"
| "allDocuments"Controls whether completions should be computed based on words in the document. Defaults to true.
wordControls whether word based completions should be included from opened documents of the same language or any language.
wordSets whether line breaks appear wherever the text would otherwise overflow its content box. When wordBreak = 'normal', Use the default line break rule. When wordBreak = 'keepAll', Word breaks should not be used for Chinese/Japanese/Korean (CJK) text. Non-CJK text behavior is the same as for normal.
wordLocales used for segmenting lines into words when doing word related navigations or operations.
Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.). Defaults to empty array
wordA string containing the word separators used when doing word navigation. Defaults to `~!@#$%^&*()-=+[{]}\|;:'",.<>/?
wordControl the wrapping of the editor.
When wordWrap = "off", the lines will never wrap.
When wordWrap = "on", the lines will wrap at the viewport width.
When wordWrap = "wordWrapColumn", the lines will wrap at wordWrapColumn.
When wordWrap = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
Defaults to "off".
wordConfigure word wrapping characters. A break will be introduced after these characters.
wordConfigure word wrapping characters. A break will be introduced before these characters.
wordControl the wrapping of the editor.
When wordWrap = "off", the lines will never wrap.
When wordWrap = "on", the lines will wrap at the viewport width.
When wordWrap = "wordWrapColumn", the lines will wrap at wordWrapColumn.
When wordWrap = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
Defaults to 80.
wordOverride the wordWrap setting.
wordOverride the wordWrapOverride1 setting.
wrapCreate a softwrap on every quoted "\n" literal. Defaults to false.
wrappingControl indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'. Defaults to 'same' in vscode and to 'none' in monaco-editor.
wrappingControls the wrapping strategy to use. Defaults to 'simple'.
The options to create an editor.