Interface IOptions

Accept suggestions on provider defined characters. Defaults to true.

Accept suggestions on ENTER. Defaults to 'on'.

An 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"

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

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

Container element to use for ARIA messages. Defaults to document.body.

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

Whether the aria-required attribute should be set on the editors textarea.

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

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

Options for pressing backspace near quotes or bracket pairs.

Options for typing over closing quotes or brackets.

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

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

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

Enable that the editor will install a ResizeObserver to check if its container dom node size has changed. Defaults to false.

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

Configures bracket pair colorization (disabled by default).

Timeout for running code actions on save.

Show code lens Defaults to true.

Code lens font family. Defaults to editor font family.

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

Enable inline color decorators and color picker rendering.

Controls what is the condition to spawn a color picker from a color dectorator

Controls the max number of color decorators that can be rendered in an editor at once.

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

Control the behaviour of comments in the editor.

Enable custom contextmenu. Defaults to true.

Syntax highlighting is copied.

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

Enable smooth caret animation. Defaults to 'off'.

Control the cursor style in insert mode. Defaults to 'line'.

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

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

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

Controls whether to use default color decorations or not using the default document color provider

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

Controls whether tabSize and insertSpaces will be automatically detected when a file is opened based on the file contents. Defaults to true.

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

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.

Disable the optimizations for monospace fonts. Defaults to false.

Should the textarea used for input use the DOM readonly attribute. Defaults to false.

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

Controls dropping into the editor from an external source.

When enabled, this shows a preview of the drop location and triggers an onDropIntoEditor event.

Copying without a selection copies the current line.

Sets whether the new experimental edit context should be used instead of the text area.

Enable experimental rendering using WebGPU. Defaults to 'off'.

Enable experimental whitespace rendering. Defaults to 'svg'.

Class name to be added to the editor.

FastScrolling mulitplier speed when pressing Alt Defaults to 5.

Control the behavior of the find widget.

Display overflow widgets as fixed. Defaults to false.

Enable code folding. Defaults to true.

Enable highlight for folded regions. Defaults to true.

Auto fold imports folding regions. Defaults to true.

Maximum number of foldable regions. Defaults to 5000.

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

The font family

Enable font ligatures. Defaults to false.

The font size

Enable font variations. Defaults to false.

The font weight

Enable format on paste. Defaults to false.

Enable format on type. Defaults to false.

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

Controls the behavior of editor guides.

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

Configure the editor's hover.

This editor is used inside a diff editor.

Control the behavior and rendering of the inline hints.

Controls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.

Insert spaces when pressing Tab. This setting is overridden based on the file contents when detectIndentation is on. Defaults to true.

The initial language of the auto created model in the editor. To not automatically create a model, use model: null.

Special handling for large files to disable certain memory intensive features. Defaults to true.

The letter spacing

Control the behavior and rendering of the code action lightbulb.

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.

The line height

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

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

Enable linked editing. Defaults to false.

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

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

Controls whether suggestions allow matches in the middle of the word instead of only at the beginning

Lines above this length will not be tokenized for performance reasons. Defaults to 20000.

Control the behavior and rendering of the minimap.

The initial model associated with this code editor.

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

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

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

Controls the max number of text cursors that can be in an active editor at once.

Merge overlapping selections. Defaults to true

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

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

Enable 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

Controls delay for occurrences highlighting Defaults to 250. Minimum value is 0 Maximum value is 2000

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

Control the cursor style in overtype mode. Defaults to 'block'.

Controls whether paste in overtype mode should overwrite or insert.

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

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

Controls the spacing around the editor.

Parameter hint options.

Controls support for changing how content is pasted into the editor.

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

Sets a placeholder for the editor. If set, the placeholder is shown if the editor is empty.

Enable quick suggestions (shadow suggestions) Defaults to true.

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

Should the editor be read only. See also domReadOnly. Defaults to false.

The message to display when the editor is readonly.

deprecated, use linkedEditing instead

Enable rendering of control characters. Defaults to true.

Render last line number when the file ends with a newline. Defaults to 'on' for Windows and macOS and 'dimmed' for Linux.

Enable rendering of current line highlight. Defaults to all.

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

Should the editor render validation decorations. Defaults to editable.

Enable rendering of whitespace. Defaults to 'selection'.

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).

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

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

Control whether a screen reader announces inline suggestion content immediately.

Control the behavior and rendering of the scrollbars.

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

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

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

Enable Linux primary clipboard. Defaults to true.

Enable selection highlight. Defaults to true.

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

Controls 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'.

Controls strikethrough deprecated variables.

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

Controls fading out of unused variables.

Smart select options.

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

Enable snippet suggestions. Default to 'true'.

Keep peek editors open even when double-clicking their content or when hitting Escape. Defaults to false.

Control the behavior of sticky scroll options

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

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

Suggest options.

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

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

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

The history mode for suggestions.

Enable tab completion.

Controls whether the editor / terminal receives tabs or defers them to the workbench for navigation.

The tabindex property of the editor's textarea

The number of spaces a tab is equal to. This setting is overridden based on the file contents when detectIndentation is on. Defaults to 4.

Initial 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.

Remove trailing auto inserted whitespace. Defaults to true.

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

Controls the behavior of the unicode highlight feature (by default, ambiguous and invisible characters are highlighted).

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

Control if the editor should use shadow DOM.

Inserting and deleting whitespace follows tab stops.

The initial value of the auto created model in the editor. To not automatically create a model, use model: null.

Controls whether completions should be computed based on words in the document. Defaults to true.

Controls whether word based completions should be included from opened documents of the same language or any language.

Sets 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.

Locales 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

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

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".

Configure word wrapping characters. A break will be introduced after these characters.

Configure word wrapping characters. A break will be introduced before these characters.

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.

Override the wordWrap setting.

Override the wordWrapOverride1 setting.

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

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