Interface: MonacoEditorProps
Vue component props for Monaco Editor.
Properties
| Property | Type | Description |
|---|---|---|
acceptSuggestionOnCommitCharacter? | boolean | MonacoEditorComponentOptions.acceptSuggestionOnCommitCharacter |
acceptSuggestionOnEnter? | "on" | "smart" | "off" | MonacoEditorComponentOptions.acceptSuggestionOnEnter |
accessibilityHelpUrl? | string | MonacoEditorComponentOptions.accessibilityHelpUrl |
accessibilityPageSize? | number | MonacoEditorComponentOptions.accessibilityPageSize |
accessibilitySupport? | "on" | "off" | "auto" | MonacoEditorComponentOptions.accessibilitySupport |
ariaContainerElement? | HTMLElement | MonacoEditorComponentOptions.ariaContainerElement |
ariaLabel? | string | MonacoEditorComponentOptions.ariaLabel |
ariaRequired? | boolean | MonacoEditorComponentOptions.ariaRequired |
autoClosingBrackets? | EditorAutoClosingStrategy | MonacoEditorComponentOptions.autoClosingBrackets |
autoClosingComments? | EditorAutoClosingStrategy | MonacoEditorComponentOptions.autoClosingComments |
autoClosingDelete? | EditorAutoClosingEditStrategy | MonacoEditorComponentOptions.autoClosingDelete |
autoClosingOvertype? | EditorAutoClosingEditStrategy | MonacoEditorComponentOptions.autoClosingOvertype |
autoClosingQuotes? | EditorAutoClosingStrategy | MonacoEditorComponentOptions.autoClosingQuotes |
autoDetectHighContrast? | boolean | MonacoEditorComponentOptions.autoDetectHighContrast |
autoIndent? | "none" | "advanced" | "full" | "brackets" | "keep" | MonacoEditorComponentOptions.autoIndent |
automaticLayout? | boolean | MonacoEditorComponentOptions.automaticLayout |
autoSurround? | EditorAutoSurroundStrategy | MonacoEditorComponentOptions.autoSurround |
bracketPairColorization? | IBracketPairColorizationOptions | MonacoEditorComponentOptions.bracketPairColorization |
codeActionsOnSaveTimeout? | number | MonacoEditorComponentOptions.codeActionsOnSaveTimeout |
codeLens? | boolean | MonacoEditorComponentOptions.codeLens |
codeLensFontFamily? | string | MonacoEditorComponentOptions.codeLensFontFamily |
codeLensFontSize? | number | MonacoEditorComponentOptions.codeLensFontSize |
colorDecorators? | boolean | MonacoEditorComponentOptions.colorDecorators |
colorDecoratorsActivatedOn? | "clickAndHover" | "click" | "hover" | MonacoEditorComponentOptions.colorDecoratorsActivatedOn |
colorDecoratorsLimit? | number | MonacoEditorComponentOptions.colorDecoratorsLimit |
columnSelection? | boolean | MonacoEditorComponentOptions.columnSelection |
comments? | IEditorCommentsOptions | MonacoEditorComponentOptions.comments |
contextmenu? | boolean | MonacoEditorComponentOptions.contextmenu |
copyWithSyntaxHighlighting? | boolean | MonacoEditorComponentOptions.copyWithSyntaxHighlighting |
cssModeConfiguration? | ModeConfiguration | Monaco CSS language mode configuration. Controls which CSS language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.ModeConfiguration.html |
cssOptions? | Options | Monaco CSS language options. Allows customization of CSS language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.Options.html |
cursorBlinking? | "blink" | "smooth" | "phase" | "expand" | "solid" | MonacoEditorComponentOptions.cursorBlinking |
cursorSmoothCaretAnimation? | "on" | "off" | "explicit" | MonacoEditorComponentOptions.cursorSmoothCaretAnimation |
cursorStyle? | | "line" | "block" | "underline" | "line-thin" | "block-outline" | "underline-thin" | MonacoEditorComponentOptions.cursorStyle |
cursorSurroundingLines? | number | MonacoEditorComponentOptions.cursorSurroundingLines |
cursorSurroundingLinesStyle? | "default" | "all" | MonacoEditorComponentOptions.cursorSurroundingLinesStyle |
cursorWidth? | number | MonacoEditorComponentOptions.cursorWidth |
defaultColorDecorators? | "auto" | "always" | "never" | MonacoEditorComponentOptions.defaultColorDecorators |
definitionLinkOpensInPeek? | boolean | MonacoEditorComponentOptions.definitionLinkOpensInPeek |
detectIndentation? | boolean | MonacoEditorComponentOptions.detectIndentation |
dimension? | IDimension | MonacoEditorComponentOptions.dimension |
disableLayerHinting? | boolean | MonacoEditorComponentOptions.disableLayerHinting |
disableMonospaceOptimizations? | boolean | MonacoEditorComponentOptions.disableMonospaceOptimizations |
domReadOnly? | boolean | MonacoEditorComponentOptions.domReadOnly |
dragAndDrop? | boolean | MonacoEditorComponentOptions.dragAndDrop |
dropIntoEditor? | IDropIntoEditorOptions | MonacoEditorComponentOptions.dropIntoEditor |
emptySelectionClipboard? | boolean | MonacoEditorComponentOptions.emptySelectionClipboard |
experimentalWhitespaceRendering? | "off" | "svg" | "font" | MonacoEditorComponentOptions.experimentalWhitespaceRendering |
extraEditorClassName? | string | MonacoEditorComponentOptions.extraEditorClassName |
extraLibs? | MonacoExtraLibraries | Additional libraries to be loaded into the Monaco editor. This is useful for adding custom types or definitions that are not included by default. The libraries should be provided in filename: content pairs. |
fastScrollSensitivity? | number | MonacoEditorComponentOptions.fastScrollSensitivity |
file | Uri | - |
find? | IEditorFindOptions | MonacoEditorComponentOptions.find |
fixedOverflowWidgets? | boolean | MonacoEditorComponentOptions.fixedOverflowWidgets |
folding? | boolean | MonacoEditorComponentOptions.folding |
foldingHighlight? | boolean | MonacoEditorComponentOptions.foldingHighlight |
foldingImportsByDefault? | boolean | MonacoEditorComponentOptions.foldingImportsByDefault |
foldingMaximumRegions? | number | MonacoEditorComponentOptions.foldingMaximumRegions |
foldingStrategy? | "auto" | "indentation" | MonacoEditorComponentOptions.foldingStrategy |
fontFamily? | string | MonacoEditorComponentOptions.fontFamily |
fontLigatures? | string | boolean | MonacoEditorComponentOptions.fontLigatures |
fontSize? | number | MonacoEditorComponentOptions.fontSize |
fontVariations? | string | boolean | MonacoEditorComponentOptions.fontVariations |
fontWeight? | string | MonacoEditorComponentOptions.fontWeight |
formatOnPaste? | boolean | MonacoEditorComponentOptions.formatOnPaste |
formatOnType? | boolean | MonacoEditorComponentOptions.formatOnType |
fs | NVEFileSystem | The NVEFileSystem instance to use as the file system for the Monaco Editor. |
glyphMargin? | boolean | MonacoEditorComponentOptions.glyphMargin |
gotoLocation? | IGotoLocationOptions | MonacoEditorComponentOptions.gotoLocation |
guides? | IGuidesOptions | MonacoEditorComponentOptions.guides |
handlebarModeConfiguration? | ModeConfiguration | Monaco Handlebars language mode configuration. Controls which Handlebars language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.ModeConfiguration.html |
handlebarOptions? | Options | Monaco Handlebars language options. Allows customization of Handlebars language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.Options.html |
hideCursorInOverviewRuler? | boolean | MonacoEditorComponentOptions.hideCursorInOverviewRuler |
hover? | IEditorHoverOptions | MonacoEditorComponentOptions.hover |
htmlModeConfiguration? | ModeConfiguration | Monaco HTML language mode configuration. Controls which HTML language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.ModeConfiguration.html |
htmlOptions? | Options | Monaco HTML language options. Allows customization of HTML language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.Options.html |
inDiffEditor? | boolean | MonacoEditorComponentOptions.inDiffEditor |
inlayHints? | IEditorInlayHintsOptions | MonacoEditorComponentOptions.inlayHints |
inlineCompletionsAccessibilityVerbose? | boolean | MonacoEditorComponentOptions.inlineCompletionsAccessibilityVerbose |
inlineSuggest? | IInlineSuggestOptions | MonacoEditorComponentOptions.inlineSuggest |
insertSpaces? | boolean | MonacoEditorComponentOptions.insertSpaces |
javascriptCompilerOptions? | CompilerOptions | Monaco JavaScript compiler options. Allows customization of JavaScript language service and transpilation behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.CompilerOptions.html |
javascriptDiagnosticsOptions? | DiagnosticsOptions | Monaco JavaScript diagnostics options. Allows customization of JavaScript validation and diagnostics behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.DiagnosticsOptions.html |
javascriptModeConfiguration? | ModeConfiguration | Monaco JavaScript language mode configuration. Controls which JavaScript language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.ModeConfiguration.html |
jsonDiagnosticsOptions? | DiagnosticsOptions | Monaco JSON diagnostics options. Allows customization of JSON validation and diagnostics behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.json.DiagnosticsOptions.html |
jsonModeConfiguration? | ModeConfiguration | Monaco JSON language mode configuration. Controls which JSON language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.json.ModeConfiguration.html |
largeFileOptimizations? | boolean | MonacoEditorComponentOptions.largeFileOptimizations |
lessModeConfiguration? | ModeConfiguration | Monaco LESS language mode configuration. Controls which LESS language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.ModeConfiguration.html |
lessOptions? | Options | Monaco LESS language options. Allows customization of LESS language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.Options.html |
letterSpacing? | number | MonacoEditorComponentOptions.letterSpacing |
lightbulb? | IEditorLightbulbOptions | MonacoEditorComponentOptions.lightbulb |
lineDecorationsWidth? | string | number | MonacoEditorComponentOptions.lineDecorationsWidth |
lineHeight? | number | MonacoEditorComponentOptions.lineHeight |
lineNumbers? | LineNumbersType | MonacoEditorComponentOptions.lineNumbers |
lineNumbersMinChars? | number | MonacoEditorComponentOptions.lineNumbersMinChars |
linkedEditing? | boolean | MonacoEditorComponentOptions.linkedEditing |
links? | boolean | MonacoEditorComponentOptions.links |
matchBrackets? | "always" | "never" | "near" | MonacoEditorComponentOptions.matchBrackets |
matchOnWordStartOnly? | boolean | MonacoEditorComponentOptions.matchOnWordStartOnly |
maxTokenizationLineLength? | number | MonacoEditorComponentOptions.maxTokenizationLineLength |
minimap? | IEditorMinimapOptions | MonacoEditorComponentOptions.minimap |
mouseStyle? | "default" | "text" | "copy" | MonacoEditorComponentOptions.mouseStyle |
mouseWheelScrollSensitivity? | number | MonacoEditorComponentOptions.mouseWheelScrollSensitivity |
mouseWheelZoom? | boolean | MonacoEditorComponentOptions.mouseWheelZoom |
multiCursorLimit? | number | MonacoEditorComponentOptions.multiCursorLimit |
multiCursorMergeOverlapping? | boolean | MonacoEditorComponentOptions.multiCursorMergeOverlapping |
multiCursorModifier? | "alt" | "ctrlCmd" | MonacoEditorComponentOptions.multiCursorModifier |
multiCursorPaste? | "full" | "spread" | MonacoEditorComponentOptions.multiCursorPaste |
occurrencesHighlight? | "off" | "singleFile" | "multiFile" | MonacoEditorComponentOptions.occurrencesHighlight |
onAfterCreate? | (instance: IStandaloneCodeEditor) => void | - |
onInit? | (monaco: any, editor: any) => void | Promise<void> | - |
overflowWidgetsDomNode? | HTMLElement | MonacoEditorComponentOptions.overflowWidgetsDomNode |
overviewRulerBorder? | boolean | MonacoEditorComponentOptions.overviewRulerBorder |
overviewRulerLanes? | number | MonacoEditorComponentOptions.overviewRulerLanes |
padding? | IEditorPaddingOptions | MonacoEditorComponentOptions.padding |
parameterHints? | IEditorParameterHintOptions | MonacoEditorComponentOptions.parameterHints |
pasteAs? | IPasteAsOptions | MonacoEditorComponentOptions.pasteAs |
peekWidgetDefaultFocus? | "tree" | "editor" | MonacoEditorComponentOptions.peekWidgetDefaultFocus |
placeholder? | string | MonacoEditorComponentOptions.placeholder |
quickSuggestions? | boolean | IQuickSuggestionsOptions | MonacoEditorComponentOptions.quickSuggestions |
quickSuggestionsDelay? | number | MonacoEditorComponentOptions.quickSuggestionsDelay |
razorModeConfiguration? | ModeConfiguration | Monaco Razor language mode configuration. Controls which Razor language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.ModeConfiguration.html |
razorOptions? | Options | Monaco Razor language options. Allows customization of Razor language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.html.Options.html |
readOnly? | boolean | MonacoEditorComponentOptions.readOnly |
readOnlyMessage? | IMarkdownString | MonacoEditorComponentOptions.readOnlyMessage |
renderControlCharacters? | boolean | MonacoEditorComponentOptions.renderControlCharacters |
renderFinalNewline? | "on" | "off" | "dimmed" | MonacoEditorComponentOptions.renderFinalNewline |
renderLineHighlight? | "none" | "line" | "all" | "gutter" | MonacoEditorComponentOptions.renderLineHighlight |
renderLineHighlightOnlyWhenFocus? | boolean | MonacoEditorComponentOptions.renderLineHighlightOnlyWhenFocus |
renderValidationDecorations? | "on" | "off" | "editable" | MonacoEditorComponentOptions.renderValidationDecorations |
renderWhitespace? | "none" | "all" | "boundary" | "selection" | "trailing" | MonacoEditorComponentOptions.renderWhitespace |
revealHorizontalRightPadding? | number | MonacoEditorComponentOptions.revealHorizontalRightPadding |
roundedSelection? | boolean | MonacoEditorComponentOptions.roundedSelection |
rulers? | (number | IRulerOption)[] | MonacoEditorComponentOptions.rulers |
screenReaderAnnounceInlineSuggestion? | boolean | MonacoEditorComponentOptions.screenReaderAnnounceInlineSuggestion |
scrollbar? | IEditorScrollbarOptions | MonacoEditorComponentOptions.scrollbar |
scrollBeyondLastColumn? | number | MonacoEditorComponentOptions.scrollBeyondLastColumn |
scrollBeyondLastLine? | boolean | MonacoEditorComponentOptions.scrollBeyondLastLine |
scrollPredominantAxis? | boolean | MonacoEditorComponentOptions.scrollPredominantAxis |
scssModeConfiguration? | ModeConfiguration | Monaco SCSS language mode configuration. Controls which SCSS language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.ModeConfiguration.html |
scssOptions? | Options | Monaco SCSS language options. Allows customization of SCSS language service behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.css.Options.html |
selectionClipboard? | boolean | MonacoEditorComponentOptions.selectionClipboard |
selectionHighlight? | boolean | MonacoEditorComponentOptions.selectionHighlight |
selectOnLineNumbers? | boolean | MonacoEditorComponentOptions.selectOnLineNumbers |
semanticHighlighting.enabled? | boolean | "configuredByTheme" | MonacoEditorComponentOptions.semanticHighlighting |
showDeprecated? | boolean | MonacoEditorComponentOptions.showDeprecated |
showFoldingControls? | "always" | "never" | "mouseover" | MonacoEditorComponentOptions.showFoldingControls |
showUnused? | boolean | MonacoEditorComponentOptions.showUnused |
smartSelect? | ISmartSelectOptions | MonacoEditorComponentOptions.smartSelect |
smoothScrolling? | boolean | MonacoEditorComponentOptions.smoothScrolling |
snippetSuggestions? | "none" | "top" | "bottom" | "inline" | MonacoEditorComponentOptions.snippetSuggestions |
stablePeek? | boolean | MonacoEditorComponentOptions.stablePeek |
stickyScroll? | IEditorStickyScrollOptions | MonacoEditorComponentOptions.stickyScroll |
stickyTabStops? | boolean | MonacoEditorComponentOptions.stickyTabStops |
stopRenderingLineAfter? | number | MonacoEditorComponentOptions.stopRenderingLineAfter |
suggest? | ISuggestOptions | MonacoEditorComponentOptions.suggest |
suggestFontSize? | number | MonacoEditorComponentOptions.suggestFontSize |
suggestLineHeight? | number | MonacoEditorComponentOptions.suggestLineHeight |
suggestOnTriggerCharacters? | boolean | MonacoEditorComponentOptions.suggestOnTriggerCharacters |
suggestSelection? | "first" | "recentlyUsed" | "recentlyUsedByPrefix" | MonacoEditorComponentOptions.suggestSelection |
tabCompletion? | "on" | "off" | "onlySnippets" | MonacoEditorComponentOptions.tabCompletion |
tabFocusMode? | boolean | MonacoEditorComponentOptions.tabFocusMode |
tabIndex? | number | MonacoEditorComponentOptions.tabIndex |
tabSize? | number | MonacoEditorComponentOptions.tabSize |
theme? | MonacoEditorThemes | MonacoEditorComponentOptions.theme |
trimAutoWhitespace? | boolean | MonacoEditorComponentOptions.trimAutoWhitespace |
typescriptCompilerOptions? | CompilerOptions | Monaco TypeScript compiler options. Allows customization of TypeScript language service and transpilation behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.CompilerOptions.html |
typescriptDiagnosticsOptions? | DiagnosticsOptions | Monaco TypeScript diagnostics options. Allows customization of TypeScript validation and diagnostics behavior. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.DiagnosticsOptions.html |
typescriptModeConfiguration? | ModeConfiguration | Monaco TypeScript language mode configuration. Controls which TypeScript language features are enabled in the editor. See: https://microsoft.github.io/monaco-editor/typedoc/interfaces/languages.typescript.ModeConfiguration.html |
unfoldOnClickAfterEndOfLine? | boolean | MonacoEditorComponentOptions.unfoldOnClickAfterEndOfLine |
unicodeHighlight? | IUnicodeHighlightOptions | MonacoEditorComponentOptions.unicodeHighlight |
unusualLineTerminators? | "off" | "auto" | "prompt" | MonacoEditorComponentOptions.unusualLineTerminators |
useShadowDOM? | boolean | MonacoEditorComponentOptions.useShadowDOM |
useTabStops? | boolean | MonacoEditorComponentOptions.useTabStops |
wordBasedSuggestions? | "off" | "currentDocument" | "matchingDocuments" | "allDocuments" | MonacoEditorComponentOptions.wordBasedSuggestions |
wordBasedSuggestionsOnlySameLanguage? | boolean | MonacoEditorComponentOptions.wordBasedSuggestionsOnlySameLanguage |
wordBreak? | "normal" | "keepAll" | MonacoEditorComponentOptions.wordBreak |
wordSegmenterLocales? | string | string[] | MonacoEditorComponentOptions.wordSegmenterLocales |
wordSeparators? | string | MonacoEditorComponentOptions.wordSeparators |
wordWrap? | "on" | "off" | "wordWrapColumn" | "bounded" | MonacoEditorComponentOptions.wordWrap |
wordWrapBreakAfterCharacters? | string | MonacoEditorComponentOptions.wordWrapBreakAfterCharacters |
wordWrapBreakBeforeCharacters? | string | MonacoEditorComponentOptions.wordWrapBreakBeforeCharacters |
wordWrapColumn? | number | MonacoEditorComponentOptions.wordWrapColumn |
wordWrapOverride1? | "on" | "off" | "inherit" | MonacoEditorComponentOptions.wordWrapOverride1 |
wordWrapOverride2? | "on" | "off" | "inherit" | MonacoEditorComponentOptions.wordWrapOverride2 |
wrappingIndent? | "none" | "same" | "indent" | "deepIndent" | MonacoEditorComponentOptions.wrappingIndent |
wrappingStrategy? | "advanced" | "simple" | MonacoEditorComponentOptions.wrappingStrategy |