Optional acceptAccept suggestions on provider defined characters. Defaults to true.
Optional acceptAccept suggestions on ENTER. Defaults to 'on'.
Optional accessibilityControls the number of lines in the editor that can be read out by a screen reader
Optional accessibilityConfigure the editor's accessibility support. Defaults to 'auto'. It is best to leave this to 'auto'.
Optional accessibilityWhether the diff editor aria label should be verbose.
Optional ariaThe aria label for the editor's textarea (when it is focused).
Optional ariaWhether the aria-required attribute should be set on the editors textarea.
Optional autoOptions for auto closing brackets. Defaults to language defined behavior.
Optional autoOptions for auto closing comments. Defaults to language defined behavior.
Optional autoOptions for pressing backspace near quotes or bracket pairs.
Optional autoOptions for typing over closing quotes or brackets.
Optional autoOptions for auto closing quotes. Defaults to language defined behavior.
Optional autoControls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines. Defaults to advanced.
Optional autoOptions for auto surrounding. Defaults to always allowing auto surrounding.
Optional automaticEnable that the editor will install a ResizeObserver to check if its container dom node size has changed. Defaults to false.
Optional bracketConfigures bracket pair colorization (disabled by default).
Optional codeTimeout for running code actions on save.
Optional codeShow code lens Defaults to true.
Optional codeCode lens font family. Defaults to editor font family.
Optional codeCode lens font size. Default to 90% of the editor font size
Optional colorEnable inline color decorators and color picker rendering.
Optional colorControls what is the condition to spawn a color picker from a color dectorator
Optional colorControls the max number of color decorators that can be rendered in an editor at once.
Optional columnEnable that the selection with the mouse and keys is doing column selection. Defaults to false.
Optional commentsControl the behaviour of comments in the editor.
Optional compactIf set, the diff editor is optimized for small views.
Defaults to false.
Optional contextmenuEnable custom contextmenu. Defaults to true.
Optional copySyntax highlighting is copied.
Optional cursorControl the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'. Defaults to 'blink'.
Optional cursorEnable smooth caret animation. Defaults to 'off'.
Optional cursorControl the cursor style, either 'block' or 'line'. Defaults to 'line'.
Optional cursorControls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.
Optional cursorControls when cursorSurroundingLines should be enforced
Defaults to default, cursorSurroundingLines is not enforced when cursor position is changed
by mouse.
Optional cursorControl the width of the cursor when cursorStyle is set to 'line'
Optional defaultControls whether to use default color decorations or not using the default document color provider
Optional definitionControls whether the definition link opens element in the peek widget. Defaults to false.
Optional diffDiff Algorithm
Optional diffShould the diff editor enable code lens? Defaults to false.
Optional diffControl the wrapping of the diff editor.
Optional dimensionThe initial editor dimension (to avoid measuring the container).
Optional 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.
Optional disableDisable the optimizations for monospace fonts. Defaults to false.
Optional domShould the textarea used for input use the DOM readonly attribute.
Defaults to false.
Optional dragControls if the editor should allow to move selections via drag and drop. Defaults to false.
Optional dropControls dropping into the editor from an external source.
When enabled, this shows a preview of the drop location and triggers an onDropIntoEditor event.
Optional emptyCopying without a selection copies the current line.
Optional enableAllow the user to resize the diff editor split view. Defaults to true.
Optional experimentalOptional showOptional showDefaults to false.
Optional useOnly applies when renderSideBySide is set to false.
Optional experimentalOptional experimentalEnable experimental whitespace rendering. Defaults to 'svg'.
Optional extraClass name to be added to the editor.
Optional fastFastScrolling mulitplier speed when pressing Alt
Defaults to 5.
Optional findControl the behavior of the find widget.
Optional fixedDisplay overflow widgets as fixed.
Defaults to false.
Optional foldingEnable code folding. Defaults to true.
Optional foldingEnable highlight for folded regions. Defaults to true.
Optional foldingAuto fold imports folding regions. Defaults to true.
Optional foldingMaximum number of foldable regions. Defaults to 5000.
Optional foldingSelects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy. Defaults to 'auto'.
Optional fontThe font family
Optional fontEnable font ligatures. Defaults to false.
Optional fontThe font size
Optional fontEnable font variations. Defaults to false.
Optional fontThe font weight
Optional formatEnable format on paste. Defaults to false.
Optional formatEnable format on type. Defaults to false.
Optional glyphEnable the rendering of the glyph margin. Defaults to true in vscode and to false in monaco-editor.
Optional gotoOptional guidesControls the behavior of editor guides.
Optional hideShould the cursor be hidden in the overview ruler. Defaults to false.
Optional hideOptional contextOptional enabled?: booleanOptional minimumOptional revealOptional hoverConfigure the editor's hover.
Optional ignoreCompute the diff by ignoring leading/trailing whitespace Defaults to true.
Optional inThis editor is used inside a diff editor.
Optional inlayControl the behavior and rendering of the inline hints.
Optional inlineControls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.
Optional inlineOptional isIs the diff editor inside another editor Defaults to false
Optional letterThe letter spacing
Optional lightbulbControl the behavior and rendering of the code action lightbulb.
Optional 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.
Optional lineThe line height
Optional 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.
Optional lineControl the width of line numbers, by reserving horizontal space for rendering at least an amount of digits. Defaults to 5.
Optional linkedEnable linked editing. Defaults to false.
Optional linksEnable detecting links and making them clickable. Defaults to true.
Optional matchEnable highlighting of matching brackets. Defaults to 'always'.
Optional matchControls whether suggestions allow matches in the middle of the word instead of only at the beginning
Optional maxTimeout in milliseconds after which diff computation is cancelled. Defaults to 5000.
Optional maxMaximum supported file size in MB. Defaults to 50.
Optional minimapControl the behavior and rendering of the minimap.
Optional modifiedAria label for modified editor.
Optional mouseControl the mouse pointer style, either 'text' or 'default' or 'copy' Defaults to 'text'
Optional mouseA multiplier to be used on the deltaX and deltaY of mouse wheel scroll events.
Defaults to 1.
Optional mouseZoom the font in the editor when using the mouse wheel in combination with holding Ctrl. Defaults to false.
Optional multiControls the max number of text cursors that can be in an active editor at once.
Optional multiMerge overlapping selections. Defaults to true
Optional multiThe modifier to be used to add multiple cursors with the mouse. Defaults to 'alt'
Optional multiConfigure the behaviour when pasting a text with the line count equal to the cursor count. Defaults to 'spread'.
Optional 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
Optional onlyIf the diff editor should only show the difference review mode.
Optional originalAria label for original editor.
Optional originalOriginal model should be editable? Defaults to false.
Optional overflowPlace overflow widgets inside an external DOM node. Defaults to an internal DOM node.
Optional overviewControls if a border should be drawn around the overview ruler.
Defaults to true.
Optional overviewThe number of vertical lanes the overview ruler should render. Defaults to 3.
Optional paddingControls the spacing around the editor.
Optional parameterParameter hint options.
Optional pasteControls support for changing how content is pasted into the editor.
Optional peekControls whether to focus the inline editor in the peek widget by default. Defaults to false.
Optional placeholderSets a placeholder for the editor. If set, the placeholder is shown if the editor is empty.
Optional quickEnable quick suggestions (shadow suggestions) Defaults to true.
Optional quickQuick suggestions show delay (in ms) Defaults to 10 (ms)
Optional readShould the editor be read only. See also domReadOnly.
Defaults to false.
Optional readThe message to display when the editor is readonly.
Optional renamedeprecated, use linkedEditing instead
Optional renderEnable rendering of control characters. Defaults to true.
Optional renderRender last line number when the file ends with a newline. Defaults to 'on' for Windows and macOS and 'dimmed' for Linux.
Optional renderIndicates if the gutter menu should be rendered.
Optional renderRender +/- indicators for added/deleted changes. Defaults to true.
Optional renderEnable rendering of current line highlight. Defaults to all.
Optional renderControl if the current line highlight should be rendered only the editor is focused. Defaults to false.
Optional renderShows icons in the glyph margin to revert changes. Default to true.
Optional renderIs the diff editor should render overview ruler Defaults to true
Optional renderRender the differences in two side-by-side editors. Defaults to true.
Optional renderWhen renderSideBySide is enabled, useInlineViewWhenSpaceIsLimited is set,
and the diff editor has a width less than renderSideBySideInlineBreakpoint, the inline view is used.
Optional renderShould the editor render validation decorations. Defaults to editable.
Optional renderEnable rendering of whitespace. Defaults to 'selection'.
Optional 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).
Optional roundedRender the editor selection with rounded borders. Defaults to true.
Optional rulersRender vertical lines at the specified columns. Defaults to empty array.
Optional screenControl whether a screen reader announces inline suggestion content immediately.
Optional scrollEnable that scrolling can go beyond the last column by a number of columns. Defaults to 5.
Optional scrollEnable that scrolling can go one screen size after the last line. Defaults to true.
Optional scrollEnable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad. Defaults to true.
Optional scrollbarControl the behavior and rendering of the scrollbars.
Optional selectShould the corresponding line be selected when clicking on the line number? Defaults to true.
Optional selectionEnable Linux primary clipboard. Defaults to true.
Optional selectionEnable selection highlight. Defaults to true.
Optional showControls strikethrough deprecated variables.
Optional showControls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter. Defaults to 'mouseover'.
Optional showControls fading out of unused variables.
Optional smartSmart select options.
Optional smoothEnable that the editor animates scrolling to a position. Defaults to false.
Optional snippetEnable snippet suggestions. Default to 'true'.
Optional splitThe default ratio when rendering side-by-side editors. Must be a number between 0 and 1, min sizes apply. Defaults to 0.5
Optional stickyControl the behavior of sticky scroll options
Optional stickyEmulate selection behaviour of tab characters when using spaces for indentation. This means selection will stick to tab stops.
Optional stopPerformance guard: Stop rendering a line after x characters. Defaults to 10000. Use -1 to never stop rendering
Optional suggestSuggest options.
Optional suggestThe font size for the suggest widget. Defaults to the editor font size.
Optional suggestThe line height for the suggest widget. Defaults to the editor line height.
Optional suggestEnable the suggestion box to pop-up on trigger characters. Defaults to true.
Optional suggestThe history mode for suggestions.
Optional tabEnable tab completion.
Optional tabControls whether the editor / terminal receives tabs or defers them to the workbench for navigation.
Optional tabThe tabindex property of the editor's textarea
Optional unfoldControls whether clicking on the empty content after a folded line will unfold the line. Defaults to false.
Optional unicodeControls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).
Optional unusualRemove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to 'prompt'.
Optional useWhen renderSideBySide is enabled, useInlineViewWhenSpaceIsLimited is set,
and the diff editor has a width less than renderSideBySideInlineBreakpoint, the inline view is used.
Optional useControl if the editor should use shadow DOM.
Optional useInserting and deleting whitespace follows tab stops.
Optional 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.
Optional 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
Optional wordA string containing the word separators used when doing word navigation. Defaults to `~!@#$%^&*()-=+[{]}\|;:'",.<>/?
Optional 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".
Optional wordConfigure word wrapping characters. A break will be introduced after these characters.
Optional wordConfigure word wrapping characters. A break will be introduced before these characters.
Optional 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.
Optional wordOverride the wordWrap setting.
Optional wordOverride the wordWrapOverride1 setting.
Optional wrappingControl indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'. Defaults to 'same' in vscode and to 'none' in monaco-editor.
Optional wrappingControls the wrapping strategy to use. Defaults to 'simple'.
Configuration options for the diff editor.