The options to create a diff editor.





Optional acceptSuggestionOnCommitCharacter

acceptSuggestionOnCommitCharacter: boolean

Accept suggestions on provider defined characters. Defaults to true.

Optional acceptSuggestionOnEnter

acceptSuggestionOnEnter: "on" | "off" | "smart"

Accept suggestions on ENTER. Defaults to 'on'.

Optional accessibilityPageSize

accessibilityPageSize: number

Controls the number of lines in the editor that can be read out by a screen reader

Optional accessibilitySupport

accessibilitySupport: "on" | "off" | "auto"

Configure the editor's accessibility support. Defaults to 'auto'. It is best to leave this to 'auto'.

Optional ariaLabel

ariaLabel: string

The aria label for the editor's textarea (when it is focused).

Optional autoClosingBrackets

autoClosingBrackets: EditorAutoClosingStrategy

Options for auto closing brackets. Defaults to language defined behavior.

Optional autoClosingOvertype

Options for typing over closing quotes or brackets.

Optional autoClosingQuotes

autoClosingQuotes: EditorAutoClosingStrategy

Options for auto closing quotes. Defaults to language defined behavior.

Optional autoDetectHighContrast

autoDetectHighContrast: boolean

If enabled, will automatically change to high contrast theme if the OS is using a high contrast theme. Defaults to true.

Optional autoIndent

autoIndent: "none" | "advanced" | "full" | "brackets" | "keep"

Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines. Defaults to advanced.

Optional autoSurround

Options for auto surrounding. Defaults to always allowing auto surrounding.

Optional automaticLayout

automaticLayout: boolean

Enable that the editor will install an interval to check if its container dom node size has changed. Enabling this might have a severe performance impact. Defaults to false.

Optional codeActionsOnSaveTimeout

codeActionsOnSaveTimeout: number

Timeout for running code actions on save.

Optional codeLens

codeLens: boolean

Show code lens Defaults to true.

Optional codeLensFontFamily

codeLensFontFamily: string

Code lens font family. Defaults to editor font family.

Optional codeLensFontSize

codeLensFontSize: number

Code lens font size. Default to 90% of the editor font size

Optional colorDecorators

colorDecorators: boolean

Enable inline color decorators and color picker rendering.

Optional columnSelection

columnSelection: boolean

Enable that the selection with the mouse and keys is doing column selection. Defaults to false.

Optional comments

Control the behaviour of comments in the editor.

Optional contextmenu

contextmenu: boolean

Enable custom contextmenu. Defaults to true.

Optional copyWithSyntaxHighlighting

copyWithSyntaxHighlighting: boolean

Syntax highlighting is copied.

Optional cursorBlinking

cursorBlinking: "blink" | "smooth" | "phase" | "expand" | "solid"

Control the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'. Defaults to 'blink'.

Optional cursorSmoothCaretAnimation

cursorSmoothCaretAnimation: boolean

Enable smooth caret animation. Defaults to false.

Optional cursorStyle

cursorStyle: "line" | "block" | "underline" | "line-thin" | "block-outline" | "underline-thin"

Control the cursor style, either 'block' or 'line'. Defaults to 'line'.

Optional cursorSurroundingLines

cursorSurroundingLines: number

Controls the minimal number of visible leading and trailing lines surrounding the cursor. Defaults to 0.

Optional cursorSurroundingLinesStyle

cursorSurroundingLinesStyle: "default" | "all"

Controls when cursorSurroundingLines should be enforced Defaults to default, cursorSurroundingLines is not enforced when cursor position is changed by mouse.

Optional cursorWidth

cursorWidth: number

Control the width of the cursor when cursorStyle is set to 'line'

Optional definitionLinkOpensInPeek

definitionLinkOpensInPeek: boolean

Controls whether the definition link opens element in the peek widget. Defaults to false.

Optional diffCodeLens

diffCodeLens: boolean

Should the diff editor enable code lens? Defaults to false.

Optional diffWordWrap

diffWordWrap: "on" | "off" | "inherit"

Control the wrapping of the diff editor.

Optional dimension

dimension: IDimension

The initial editor dimension (to avoid measuring the container).

Optional disableLayerHinting

disableLayerHinting: boolean

Disable 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 disableMonospaceOptimizations

disableMonospaceOptimizations: boolean

Disable the optimizations for monospace fonts. Defaults to false.

Optional dragAndDrop

dragAndDrop: boolean

Controls if the editor should allow to move selections via drag and drop. Defaults to false.

Optional emptySelectionClipboard

emptySelectionClipboard: boolean

Copying without a selection copies the current line.

Optional enableSplitViewResizing

enableSplitViewResizing: boolean

Allow the user to resize the diff editor split view. Defaults to true.

Optional extraEditorClassName

extraEditorClassName: string

Class name to be added to the editor.

Optional fastScrollSensitivity

fastScrollSensitivity: number

FastScrolling mulitplier speed when pressing Alt Defaults to 5.

Optional find

Control the behavior of the find widget.

Optional fixedOverflowWidgets

fixedOverflowWidgets: boolean

Display overflow widgets as fixed. Defaults to false.

Optional folding

folding: boolean

Enable code folding. Defaults to true.

Optional foldingHighlight

foldingHighlight: boolean

Enable highlight for folded regions. Defaults to true.

Optional foldingStrategy

foldingStrategy: "auto" | "indentation"

Selects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy. Defaults to 'auto'.

Optional fontFamily

fontFamily: string

The font family

Optional fontLigatures

fontLigatures: string | boolean

Enable font ligatures. Defaults to false.

Optional fontSize

fontSize: number

The font size

Optional fontWeight

fontWeight: string

The font weight

Optional formatOnPaste

formatOnPaste: boolean

Enable format on paste. Defaults to false.

Optional formatOnType

formatOnType: boolean

Enable format on type. Defaults to false.

Optional glyphMargin

glyphMargin: boolean

Enable the rendering of the glyph margin. Defaults to true in vscode and to false in monaco-editor.

Optional gotoLocation

gotoLocation: IGotoLocationOptions

Optional hideCursorInOverviewRuler

hideCursorInOverviewRuler: boolean

Should the cursor be hidden in the overview ruler. Defaults to false.

Optional highlightActiveIndentGuide

highlightActiveIndentGuide: boolean

Enable highlighting of the active indent guide. Defaults to true.

Optional hover

Configure the editor's hover.

Optional ignoreTrimWhitespace

ignoreTrimWhitespace: boolean

Compute the diff by ignoring leading/trailing whitespace Defaults to true.

Optional inDiffEditor

inDiffEditor: boolean

This editor is used inside a diff editor.

Optional inlineHints

Control the behavior and rendering of the inline hints.

Optional isInEmbeddedEditor

isInEmbeddedEditor: boolean

Is the diff editor inside another editor Defaults to false

Optional letterSpacing

letterSpacing: number

The letter spacing

Optional lightbulb

Control the behavior and rendering of the code action lightbulb.

Optional lineDecorationsWidth

lineDecorationsWidth: string | number

The 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 lineHeight

lineHeight: number

The line height

Optional lineNumbers

lineNumbers: LineNumbersType

Control 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 truey, line numbers will be rendered normally (equivalent of using an identity function). Otherwise, line numbers will not be rendered. Defaults to on.

Optional lineNumbersMinChars

lineNumbersMinChars: number

Control the width of line numbers, by reserving horizontal space for rendering at least an amount of digits. Defaults to 5.

Optional linkedEditing

linkedEditing: boolean

Enable linked editing. Defaults to false.

Optional links

links: boolean

Enable detecting links and making them clickable. Defaults to true.

Optional matchBrackets

matchBrackets: "always" | "never" | "near"

Enable highlighting of matching brackets. Defaults to 'always'.

Optional maxComputationTime

maxComputationTime: number

Timeout in milliseconds after which diff computation is cancelled. Defaults to 5000.

Optional minimap

Control the behavior and rendering of the minimap.

Optional modifiedAriaLabel

modifiedAriaLabel: string

Aria label for modifed editor.

Optional mouseStyle

mouseStyle: "default" | "text" | "copy"

Control the mouse pointer style, either 'text' or 'default' or 'copy' Defaults to 'text'

Optional mouseWheelScrollSensitivity

mouseWheelScrollSensitivity: number

A multiplier to be used on the deltaX and deltaY of mouse wheel scroll events. Defaults to 1.

Optional mouseWheelZoom

mouseWheelZoom: boolean

Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl. Defaults to false.

Optional multiCursorMergeOverlapping

multiCursorMergeOverlapping: boolean

Merge overlapping selections. Defaults to true

Optional multiCursorModifier

multiCursorModifier: "ctrlCmd" | "alt"

The modifier to be used to add multiple cursors with the mouse. Defaults to 'alt'

Optional multiCursorPaste

multiCursorPaste: "spread" | "full"

Configure the behaviour when pasting a text with the line count equal to the cursor count. Defaults to 'spread'.

Optional occurrencesHighlight

occurrencesHighlight: boolean

Enable semantic occurrences highlight. Defaults to true.

Optional originalAriaLabel

originalAriaLabel: string

Aria label for original editor.

Optional originalEditable

originalEditable: boolean

Original model should be editable? Defaults to false.

Optional overflowWidgetsDomNode

overflowWidgetsDomNode: HTMLElement

Place overflow widgets inside an external DOM node. Defaults to an internal DOM node.

Optional overviewRulerBorder

overviewRulerBorder: boolean

Controls if a border should be drawn around the overview ruler. Defaults to true.

Optional overviewRulerLanes

overviewRulerLanes: number

The number of vertical lanes the overview ruler should render. Defaults to 3.

Optional padding

Controls the spacing around the editor.

Optional parameterHints

Parameter hint options.

Optional peekWidgetDefaultFocus

peekWidgetDefaultFocus: "tree" | "editor"

Controls whether to focus the inline editor in the peek widget by default. Defaults to false.

Optional quickSuggestions

quickSuggestions: boolean | IQuickSuggestionsOptions

Enable quick suggestions (shadow suggestions) Defaults to true.

Optional quickSuggestionsDelay

quickSuggestionsDelay: number

Quick suggestions show delay (in ms) Defaults to 10 (ms)

Optional readOnly

readOnly: boolean

Should the editor be read only. Defaults to false.

Optional renameOnType

renameOnType: boolean

deprecated, use linkedEditing instead

Optional renderControlCharacters

renderControlCharacters: boolean

Enable rendering of control characters. Defaults to false.

Optional renderFinalNewline

renderFinalNewline: boolean

Render last line number when the file ends with a newline. Defaults to true.

Optional renderIndentGuides

renderIndentGuides: boolean

Enable rendering of indent guides. Defaults to true.

Optional renderIndicators

renderIndicators: boolean

Render +/- indicators for added/deleted changes. Defaults to true.

Optional renderLineHighlight

renderLineHighlight: "all" | "line" | "none" | "gutter"

Enable rendering of current line highlight. Defaults to all.

Optional renderLineHighlightOnlyWhenFocus

renderLineHighlightOnlyWhenFocus: boolean

Control if the current line highlight should be rendered only the editor is focused. Defaults to false.

Optional renderOverviewRuler

renderOverviewRuler: boolean

Is the diff editor should render overview ruler Defaults to true

Optional renderSideBySide

renderSideBySide: boolean

Render the differences in two side-by-side editors. Defaults to true.

Optional renderValidationDecorations

renderValidationDecorations: "on" | "off" | "editable"

Should the editor render validation decorations. Defaults to editable.

Optional renderWhitespace

renderWhitespace: "all" | "none" | "boundary" | "selection" | "trailing"

Enable rendering of whitespace. Defaults to none.

Optional revealHorizontalRightPadding

revealHorizontalRightPadding: number

When 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 roundedSelection

roundedSelection: boolean

Render the editor selection with rounded borders. Defaults to true.

Optional rulers

rulers: (number | IRulerOption)[]

Render vertical lines at the specified columns. Defaults to empty array.

Optional scrollBeyondLastColumn

scrollBeyondLastColumn: number

Enable that scrolling can go beyond the last column by a number of columns. Defaults to 5.

Optional scrollBeyondLastLine

scrollBeyondLastLine: boolean

Enable that scrolling can go one screen size after the last line. Defaults to true.

Optional scrollPredominantAxis

scrollPredominantAxis: boolean

Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad. Defaults to true.

Optional scrollbar

Control the behavior and rendering of the scrollbars.

Optional selectOnLineNumbers

selectOnLineNumbers: boolean

Should the corresponding line be selected when clicking on the line number? Defaults to true.

Optional selectionClipboard

selectionClipboard: boolean

Enable Linux primary clipboard. Defaults to true.

Optional selectionHighlight

selectionHighlight: boolean

Enable selection highlight. Defaults to true.

Optional showDeprecated

showDeprecated: boolean

Controls strikethrough deprecated variables.

Optional showFoldingControls

showFoldingControls: "always" | "mouseover"

Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter. Defaults to 'mouseover'.

Optional showUnused

showUnused: boolean

Controls fading out of unused variables.

Optional smartSelect

smartSelect: ISmartSelectOptions

Smart select opptions;

Optional smoothScrolling

smoothScrolling: boolean

Enable that the editor animates scrolling to a position. Defaults to false.

Optional snippetSuggestions

snippetSuggestions: "none" | "top" | "bottom" | "inline"

Enable snippet suggestions. Default to 'true'.

Optional stickyTabStops

stickyTabStops: boolean

Emulate selection behaviour of tab characters when using spaces for indentation. This means selection will stick to tab stops.

Optional stopRenderingLineAfter

stopRenderingLineAfter: number

Performance guard: Stop rendering a line after x characters. Defaults to 10000. Use -1 to never stop rendering

Optional suggest

Suggest options.

Optional suggestFontSize

suggestFontSize: number

The font size for the suggest widget. Defaults to the editor font size.

Optional suggestLineHeight

suggestLineHeight: number

The line height for the suggest widget. Defaults to the editor line height.

Optional suggestOnTriggerCharacters

suggestOnTriggerCharacters: boolean

Enable the suggestion box to pop-up on trigger characters. Defaults to true.

Optional suggestSelection

suggestSelection: "first" | "recentlyUsed" | "recentlyUsedByPrefix"

The history mode for suggestions.

Optional tabCompletion

tabCompletion: "on" | "off" | "onlySnippets"

Enable tab completion.

Optional tabIndex

tabIndex: number

The tabindex property of the editor's textarea

Optional theme

theme: string

Initial theme to be used for rendering. The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'. 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.

Optional unfoldOnClickAfterEndOfLine

unfoldOnClickAfterEndOfLine: boolean

Controls whether clicking on the empty content after a folded line will unfold the line. Defaults to false.

Optional unusualLineTerminators

unusualLineTerminators: "off" | "auto" | "prompt"

Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS). Defaults to 'prompt'.

Optional useTabStops

useTabStops: boolean

Inserting and deleting whitespace follows tab stops.

Optional wordSeparators

wordSeparators: string

A string containing the word separators used when doing word navigation. Defaults to `~!@#$%^&*()-=+[{]}\|;:'",.<>/?

Optional wordWrap

wordWrap: "on" | "off" | "wordWrapColumn" | "bounded"

Control 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 wordWrapBreakAfterCharacters

wordWrapBreakAfterCharacters: string

Configure word wrapping characters. A break will be introduced after these characters. Defaults to ' \t})]?|/&.,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」'.

Optional wordWrapBreakBeforeCharacters

wordWrapBreakBeforeCharacters: string

Configure word wrapping characters. A break will be introduced before these characters. Defaults to '([{‘“〈《「『【〔([{「£¥$£¥++'.

Optional wordWrapColumn

wordWrapColumn: number

Control 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 wordWrapOverride1

wordWrapOverride1: "on" | "off" | "inherit"

Override the wordWrap setting.

Optional wordWrapOverride2

wordWrapOverride2: "on" | "off" | "inherit"

Override the wordWrapOverride1 setting.

Optional wrappingIndent

wrappingIndent: "none" | "same" | "indent" | "deepIndent"

Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'. Defaults to 'same' in vscode and to 'none' in monaco-editor.

Optional wrappingStrategy

wrappingStrategy: "simple" | "advanced"

Controls the wrapping strategy to use. Defaults to 'simple'.