SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 07:00:11 +01:00
Code Issues Projects Releases Packages Activity

Prepare for 0.29.0

Browse source
This commit is contained in:
Alex Dima 2021-10-08 18:41:27 +02:00
parent 97ff11be97
commit f377e9e7ac
No known key found for this signature in database
GPG key ID: 39563C1504FDD0C9
6 changed files with 379 additions and 278 deletions
Download patch file Download diff file Expand all files Collapse all files

41
CHANGELOG.md
View file

@ -1,5 +1,46 @@
# Monaco Editor Changelog
## [0.29.0] (08.10.2021)
* adds an `ariaContainerElement` option for editors
* adds `guides.bracketPairs` to enable guides driven by bracket pairs
* adds `maxFileSize` to control the maximum file size for which to compute diffs
* adds `CodeActionProvider.resolveCodeAction`
### Breaking Change
* consolidated the options `renderIndentGuides`, `highlightActiveIndentGuide` to `guides`
### Thank you
Contributions to `monaco-editor`:
* [@crackalak (Dan Hughes)](https://github.com/crackalak): Added `ariaContainerElement` to shadow dom test [PR #2644](https://github.com/microsoft/monaco-editor/pull/2644)
* [@HKalbasi](https://github.com/HKalbasi): Add example for inlay hints [PR #2640](https://github.com/microsoft/monaco-editor/pull/2640)
* [@silverwind](https://github.com/silverwind): Fix letter case in repo URL [PR #2674](https://github.com/microsoft/monaco-editor/pull/2674)
* [@Un-index](https://github.com/Un-index): chore: Align run button text in playground.css [PR #2658](https://github.com/microsoft/monaco-editor/pull/2658)
Contributions to `monaco-editor-samples`:
* [@koto (Krzysztof Kotowicz)](https://github.com/koto): Added an example of loading Monaco with Trusted Types [PR #92](https://github.com/microsoft/monaco-editor-samples/pull/92)
Contributions to `monaco-editor-webpack-plugin`:
* [@six-ponies (马騳骉)](https://github.com/six-ponies): fix: Failed to execute 'importScripts' on 'WorkerGlobalScope': The URL xxx is invalid. [PR #160](https://github.com/microsoft/monaco-editor-webpack-plugin/pull/160)
Contributions to `monaco-languages`:
* [@aaaaaa2493 (Vladimir Turov)](https://github.com/aaaaaa2493): Support Java 12-17 syntax [PR #159](https://github.com/microsoft/monaco-languages/pull/159)
* [@mbtools (Marc Bernard)](https://github.com/mbtools): Update ABAP syntax [PR #160](https://github.com/microsoft/monaco-languages/pull/160)
* [@scarolan (Sean Carolan)](https://github.com/scarolan): Replace // with # for line comments [PR #158](https://github.com/microsoft/monaco-languages/pull/158)
* [@valeriia-melnychuk (Valeriia Melnychuk)](https://github.com/valeriia-melnychuk): Implement syntax highlighting for Flow9 [PR #154](https://github.com/microsoft/monaco-languages/pull/154)
Contributions to `monaco-typescript`:
* [@paranoidjk (paranoidjk)](https://github.com/paranoidjk): feat: support find reference to extraLib [PR #84](https://github.com/microsoft/monaco-typescript/pull/84)
* [@troy351](https://github.com/troy351): Add type definition of `setInlayHintsOptions` [PR #83](https://github.com/microsoft/monaco-typescript/pull/83)
## [0.28.0] (22.09.2021)
* adds [support for typescript inlay hints](https://github.com/microsoft/monaco-typescript/pull/82). Inlay hints can be enabled like this:

18
package-lock.json generated
View file

@ -2368,9 +2368,9 @@
"dev": true
},
"monaco-editor-core": {
"version": "0.28.1",
"resolved": "https://registry.npmjs.org/monaco-editor-core/-/monaco-editor-core-0.28.1.tgz",
"integrity": "sha512-ikNy6KXmgKhV66W7xLkdECJLAAzDycUe6rhXbdmUaa6L23X70Y0jOaCj/W9gqAo4wUT3MpRmeKEgujNKKH9p8A==",
"version": "0.29.1",
"resolved": "https://registry.npmjs.org/monaco-editor-core/-/monaco-editor-core-0.29.1.tgz",
"integrity": "sha512-A2+iNWf2Jhy/yAJ8HaDIszEhAlS1xjLvQfbk41yAyGwC4wDwbcTymUud1g0I9nV31S1x7QlXNC0BABc2uZN1Qg==",
"dev": true
},
"monaco-html": {
@ -2386,15 +2386,15 @@
"dev": true
},
"monaco-languages": {
"version": "2.8.1",
"resolved": "https://registry.npmjs.org/monaco-languages/-/monaco-languages-2.8.1.tgz",
"integrity": "sha512-hzUZFhuhUtTicdfhbj1xUQt2aXI/7ef5Ava4NG1Qd1HHSPPG8vFWyeKOlA+QX+EiFkiq21NWXynx4smQ/Qp61A==",
"version": "2.9.0",
"resolved": "https://registry.npmjs.org/monaco-languages/-/monaco-languages-2.9.0.tgz",
"integrity": "sha512-6a3eXBXP9kphkOb4SRA+WmhsXnV4EATIW+e0kQXiYPzdgD3CQE9M670njk9hGwKCRbyR/KK1WvlMAPKidlle3g==",
"dev": true
},
"monaco-typescript": {
"version": "4.8.1",
"resolved": "https://registry.npmjs.org/monaco-typescript/-/monaco-typescript-4.8.1.tgz",
"integrity": "sha512-H4spoQ8hTctMBd6vH/bBusF61slGCJF6BXsDkvurCcb8c8mrUhv3EiM6L09s4w/F9NJBbJ0xHezy3EvOEukEig==",
"version": "4.9.1",
"resolved": "https://registry.npmjs.org/monaco-typescript/-/monaco-typescript-4.9.1.tgz",
"integrity": "sha512-ZxvQFK40fnNg6hhkIofwyH6XzaHSmxVsI41cwSLi4eNFaP/Z58tigUJ/g9evS6Evbm67SdhxvxB4jct/tq3oXw==",
"dev": true
},
"ms": {

6
package.json
View file

@ -23,11 +23,11 @@
"event-stream": "4.0.1",
"gulp": "^4.0.2",
"monaco-css": "3.8.1",
"monaco-editor-core": "0.28.1",
"monaco-editor-core": "0.29.1",
"monaco-html": "3.8.1",
"monaco-json": "3.8.1",
"monaco-languages": "2.8.1",
"monaco-typescript": "4.8.1",
"monaco-languages": "2.9.0",
"monaco-typescript": "4.9.1",
"rimraf": "^3.0.2",
"typedoc": "^0.20.29",
"typescript": "4.2.3",

2
test/playground.generated/customizing-the-appearence-exposed-colors.html
View file

@ -144,6 +144,8 @@ monaco.editor.create(document.getElementById("container"), {
'editorLineNumber.activeForeground' // Color of editor active line number.
'editorRuler.foreground' // Color of the editor rulers.
'editorCodeLens.foreground' // Foreground color of editor code lenses
'editorInlayHint.foreground' // Foreground color of editor inlay hints
'editorInlayHint.background' // Background color of editor inlay hints
'editorBracketMatch.background' // Background color behind matching brackets
'editorBracketMatch.border' // Color for matching brackets boxes
'editorOverviewRuler.border' // Color of the overview ruler border.

295
typedoc/monaco.d.ts vendored
View file

@ -414,6 +414,7 @@ declare namespace monaco {
readonly value: string;
readonly isTrusted?: boolean;
readonly supportThemeIcons?: boolean;
readonly supportHtml?: boolean;
uris?: {
[href: string]: UriComponents;
};
@ -871,7 +872,7 @@ declare namespace monaco.editor {
* `domElement` should be empty (not contain other dom nodes).
* The editor will read the size of `domElement`.
*/
export function createDiffEditor(domElement: HTMLElement, options?: IDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;
export function createDiffEditor(domElement: HTMLElement, options?: IStandaloneDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;
export interface IDiffNavigatorOptions {
readonly followsCaret?: boolean;
@ -1184,12 +1185,12 @@ declare namespace monaco.editor {
model?: ITextModel | null;
/**
* The initial value of the auto created model in the editor.
* To not create automatically a model, use `model: null`.
* To not automatically create a model, use `model: null`.
*/
value?: string;
/**
* The initial language of the auto created model in the editor.
* To not create automatically a model, use `model: null`.
* To not automatically create a model, use `model: null`.
*/
language?: string;
/**
@ -1212,12 +1213,17 @@ declare namespace monaco.editor {
* Defaults to "https://go.microsoft.com/fwlink/?linkid=852450"
*/
accessibilityHelpUrl?: string;
/**
* Container element to use for ARIA messages.
* Defaults to document.body.
*/
ariaContainerElement?: HTMLElement;
}
/**
* The options to create a diff editor.
*/
export interface IDiffEditorConstructionOptions extends IDiffEditorOptions {
export interface IStandaloneDiffEditorConstructionOptions extends IDiffEditorConstructionOptions {
/**
* Initial theme to be used for rendering.
* The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'.
@ -3216,16 +3222,6 @@ declare namespace monaco.editor {
* Defaults to false.
*/
renderControlCharacters?: boolean;
/**
* Enable rendering of indent guides.
* Defaults to true.
*/
renderIndentGuides?: boolean;
/**
* Enable highlighting of the active indent guide.
* Defaults to true.
*/
highlightActiveIndentGuide?: boolean;
/**
* Enable rendering of current line highlight.
* Defaults to all.
@ -3286,12 +3282,13 @@ declare namespace monaco.editor {
* Control if the editor should use shadow DOM.
*/
useShadowDOM?: boolean;
/**
* Controls the behavior of editor guides.
*/
guides?: IGuidesOptions;
}
/**
* Configuration options for the diff editor.
*/
export interface IDiffEditorOptions extends IEditorOptions {
export interface IDiffEditorBaseOptions {
/**
* Allow the user to resize the diff editor split view.
* Defaults to true.
@ -3307,6 +3304,11 @@ declare namespace monaco.editor {
* Defaults to 5000.
*/
maxComputationTime?: number;
/**
* Maximum supported file size in MB.
* Defaults to 50.
*/
maxFileSize?: number;
/**
* Compute the diff by ignoring leading/trailing whitespace
* Defaults to true.
@ -3327,11 +3329,6 @@ declare namespace monaco.editor {
* Defaults to false.
*/
diffCodeLens?: boolean;
/**
* Is the diff editor inside another editor
* Defaults to false
*/
isInEmbeddedEditor?: boolean;
/**
* Is the diff editor should render overview ruler
* Defaults to true
@ -3341,14 +3338,12 @@ declare namespace monaco.editor {
* Control the wrapping of the diff editor.
*/
diffWordWrap?: 'off' | 'on' | 'inherit';
/**
* Aria label for original editor.
*/
originalAriaLabel?: string;
/**
* Aria label for modified editor.
*/
modifiedAriaLabel?: string;
}
/**
* Configuration options for the diff editor.
*/
export interface IDiffEditorOptions extends IEditorOptions, IDiffEditorBaseOptions {
}
/**
@ -3898,6 +3893,25 @@ declare namespace monaco.editor {
export type InternalBracketPairColorizationOptions = Readonly<Required<IBracketPairColorizationOptions>>;
export interface IGuidesOptions {
/**
* Enable rendering of bracket pair guides.
*/
bracketPairs?: boolean;
/**
* Enable rendering of indent guides.
* Defaults to true.
*/
indentation?: boolean;
/**
* Enable highlighting of the active indent guide.
* Defaults to true.
*/
highlightActiveIndentation?: boolean;
}
export type InternalGuidesOptions = Readonly<Required<IGuidesOptions>>;
/**
* Configuration options for editor suggest widget
*/
@ -4107,45 +4121,45 @@ declare namespace monaco.editor {
automaticLayout = 10,
autoSurround = 11,
bracketPairColorization = 12,
codeLens = 13,
codeLensFontFamily = 14,
codeLensFontSize = 15,
colorDecorators = 16,
columnSelection = 17,
comments = 18,
contextmenu = 19,
copyWithSyntaxHighlighting = 20,
cursorBlinking = 21,
cursorSmoothCaretAnimation = 22,
cursorStyle = 23,
cursorSurroundingLines = 24,
cursorSurroundingLinesStyle = 25,
cursorWidth = 26,
disableLayerHinting = 27,
disableMonospaceOptimizations = 28,
domReadOnly = 29,
dragAndDrop = 30,
emptySelectionClipboard = 31,
extraEditorClassName = 32,
fastScrollSensitivity = 33,
find = 34,
fixedOverflowWidgets = 35,
folding = 36,
foldingStrategy = 37,
foldingHighlight = 38,
foldingImportsByDefault = 39,
unfoldOnClickAfterEndOfLine = 40,
fontFamily = 41,
fontInfo = 42,
fontLigatures = 43,
fontSize = 44,
fontWeight = 45,
formatOnPaste = 46,
formatOnType = 47,
glyphMargin = 48,
gotoLocation = 49,
hideCursorInOverviewRuler = 50,
highlightActiveIndentGuide = 51,
guides = 13,
codeLens = 14,
codeLensFontFamily = 15,
codeLensFontSize = 16,
colorDecorators = 17,
columnSelection = 18,
comments = 19,
contextmenu = 20,
copyWithSyntaxHighlighting = 21,
cursorBlinking = 22,
cursorSmoothCaretAnimation = 23,
cursorStyle = 24,
cursorSurroundingLines = 25,
cursorSurroundingLinesStyle = 26,
cursorWidth = 27,
disableLayerHinting = 28,
disableMonospaceOptimizations = 29,
domReadOnly = 30,
dragAndDrop = 31,
emptySelectionClipboard = 32,
extraEditorClassName = 33,
fastScrollSensitivity = 34,
find = 35,
fixedOverflowWidgets = 36,
folding = 37,
foldingStrategy = 38,
foldingHighlight = 39,
foldingImportsByDefault = 40,
unfoldOnClickAfterEndOfLine = 41,
fontFamily = 42,
fontInfo = 43,
fontLigatures = 44,
fontSize = 45,
fontWeight = 46,
formatOnPaste = 47,
formatOnType = 48,
glyphMargin = 49,
gotoLocation = 50,
hideCursorInOverviewRuler = 51,
hover = 52,
inDiffEditor = 53,
inlineSuggest = 54,
@ -4177,55 +4191,54 @@ declare namespace monaco.editor {
readOnly = 80,
renameOnType = 81,
renderControlCharacters = 82,
renderIndentGuides = 83,
renderFinalNewline = 84,
renderLineHighlight = 85,
renderLineHighlightOnlyWhenFocus = 86,
renderValidationDecorations = 87,
renderWhitespace = 88,
revealHorizontalRightPadding = 89,
roundedSelection = 90,
rulers = 91,
scrollbar = 92,
scrollBeyondLastColumn = 93,
scrollBeyondLastLine = 94,
scrollPredominantAxis = 95,
selectionClipboard = 96,
selectionHighlight = 97,
selectOnLineNumbers = 98,
showFoldingControls = 99,
showUnused = 100,
snippetSuggestions = 101,
smartSelect = 102,
smoothScrolling = 103,
stickyTabStops = 104,
stopRenderingLineAfter = 105,
suggest = 106,
suggestFontSize = 107,
suggestLineHeight = 108,
suggestOnTriggerCharacters = 109,
suggestSelection = 110,
tabCompletion = 111,
tabIndex = 112,
unusualLineTerminators = 113,
useShadowDOM = 114,
useTabStops = 115,
wordSeparators = 116,
wordWrap = 117,
wordWrapBreakAfterCharacters = 118,
wordWrapBreakBeforeCharacters = 119,
wordWrapColumn = 120,
wordWrapOverride1 = 121,
wordWrapOverride2 = 122,
wrappingIndent = 123,
wrappingStrategy = 124,
showDeprecated = 125,
inlayHints = 126,
editorClassName = 127,
pixelRatio = 128,
tabFocusMode = 129,
layoutInfo = 130,
wrappingInfo = 131
renderFinalNewline = 83,
renderLineHighlight = 84,
renderLineHighlightOnlyWhenFocus = 85,
renderValidationDecorations = 86,
renderWhitespace = 87,
revealHorizontalRightPadding = 88,
roundedSelection = 89,
rulers = 90,
scrollbar = 91,
scrollBeyondLastColumn = 92,
scrollBeyondLastLine = 93,
scrollPredominantAxis = 94,
selectionClipboard = 95,
selectionHighlight = 96,
selectOnLineNumbers = 97,
showFoldingControls = 98,
showUnused = 99,
snippetSuggestions = 100,
smartSelect = 101,
smoothScrolling = 102,
stickyTabStops = 103,
stopRenderingLineAfter = 104,
suggest = 105,
suggestFontSize = 106,
suggestLineHeight = 107,
suggestOnTriggerCharacters = 108,
suggestSelection = 109,
tabCompletion = 110,
tabIndex = 111,
unusualLineTerminators = 112,
useShadowDOM = 113,
useTabStops = 114,
wordSeparators = 115,
wordWrap = 116,
wordWrapBreakAfterCharacters = 117,
wordWrapBreakBeforeCharacters = 118,
wordWrapColumn = 119,
wordWrapOverride1 = 120,
wordWrapOverride2 = 121,
wrappingIndent = 122,
wrappingStrategy = 123,
showDeprecated = 124,
inlayHints = 125,
editorClassName = 126,
pixelRatio = 127,
tabFocusMode = 128,
layoutInfo = 129,
wrappingInfo = 130
}
export const EditorOptions: {
acceptSuggestionOnCommitCharacter: IEditorOption<EditorOption.acceptSuggestionOnCommitCharacter, boolean>;
@ -4240,14 +4253,15 @@ declare namespace monaco.editor {
autoIndent: IEditorOption<EditorOption.autoIndent, EditorAutoIndentStrategy>;
automaticLayout: IEditorOption<EditorOption.automaticLayout, boolean>;
autoSurround: IEditorOption<EditorOption.autoSurround, 'languageDefined' | 'never' | 'quotes' | 'brackets'>;
bracketPairColorization: IEditorOption<EditorOption.bracketPairColorization, any>;
bracketPairColorization: IEditorOption<EditorOption.bracketPairColorization, Readonly<Required<IBracketPairColorizationOptions>>>;
bracketPairGuides: IEditorOption<EditorOption.guides, Readonly<Required<IGuidesOptions>>>;
stickyTabStops: IEditorOption<EditorOption.stickyTabStops, boolean>;
codeLens: IEditorOption<EditorOption.codeLens, boolean>;
codeLensFontFamily: IEditorOption<EditorOption.codeLensFontFamily, string>;
codeLensFontSize: IEditorOption<EditorOption.codeLensFontSize, number>;
colorDecorators: IEditorOption<EditorOption.colorDecorators, boolean>;
columnSelection: IEditorOption<EditorOption.columnSelection, boolean>;
comments: IEditorOption<EditorOption.comments, EditorCommentsOptions>;
comments: IEditorOption<EditorOption.comments, Readonly<Required<IEditorCommentsOptions>>>;
contextmenu: IEditorOption<EditorOption.contextmenu, boolean>;
copyWithSyntaxHighlighting: IEditorOption<EditorOption.copyWithSyntaxHighlighting, boolean>;
cursorBlinking: IEditorOption<EditorOption.cursorBlinking, TextEditorCursorBlinkingStyle>;
@ -4263,7 +4277,7 @@ declare namespace monaco.editor {
emptySelectionClipboard: IEditorOption<EditorOption.emptySelectionClipboard, boolean>;
extraEditorClassName: IEditorOption<EditorOption.extraEditorClassName, string>;
fastScrollSensitivity: IEditorOption<EditorOption.fastScrollSensitivity, number>;
find: IEditorOption<EditorOption.find, EditorFindOptions>;
find: IEditorOption<EditorOption.find, Readonly<Required<IEditorFindOptions>>>;
fixedOverflowWidgets: IEditorOption<EditorOption.fixedOverflowWidgets, boolean>;
folding: IEditorOption<EditorOption.folding, boolean>;
foldingStrategy: IEditorOption<EditorOption.foldingStrategy, 'auto' | 'indentation'>;
@ -4278,13 +4292,12 @@ declare namespace monaco.editor {
formatOnPaste: IEditorOption<EditorOption.formatOnPaste, boolean>;
formatOnType: IEditorOption<EditorOption.formatOnType, boolean>;
glyphMargin: IEditorOption<EditorOption.glyphMargin, boolean>;
gotoLocation: IEditorOption<EditorOption.gotoLocation, GoToLocationOptions>;
gotoLocation: IEditorOption<EditorOption.gotoLocation, Readonly<Required<IGotoLocationOptions>>>;
hideCursorInOverviewRuler: IEditorOption<EditorOption.hideCursorInOverviewRuler, boolean>;
highlightActiveIndentGuide: IEditorOption<EditorOption.highlightActiveIndentGuide, boolean>;
hover: IEditorOption<EditorOption.hover, EditorHoverOptions>;
hover: IEditorOption<EditorOption.hover, Readonly<Required<IEditorHoverOptions>>>;
inDiffEditor: IEditorOption<EditorOption.inDiffEditor, boolean>;
letterSpacing: IEditorOption<EditorOption.letterSpacing, number>;
lightbulb: IEditorOption<EditorOption.lightbulb, EditorLightbulbOptions>;
lightbulb: IEditorOption<EditorOption.lightbulb, Readonly<Required<IEditorLightbulbOptions>>>;
lineDecorationsWidth: IEditorOption<EditorOption.lineDecorationsWidth, string | number>;
lineHeight: IEditorOption<EditorOption.lineHeight, number>;
lineNumbers: IEditorOption<EditorOption.lineNumbers, InternalEditorRenderLineNumbersOptions>;
@ -4292,7 +4305,7 @@ declare namespace monaco.editor {
linkedEditing: IEditorOption<EditorOption.linkedEditing, boolean>;
links: IEditorOption<EditorOption.links, boolean>;
matchBrackets: IEditorOption<EditorOption.matchBrackets, 'always' | 'never' | 'near'>;
minimap: IEditorOption<EditorOption.minimap, EditorMinimapOptions>;
minimap: IEditorOption<EditorOption.minimap, Readonly<Required<IEditorMinimapOptions>>>;
mouseStyle: IEditorOption<EditorOption.mouseStyle, 'default' | 'text' | 'copy'>;
mouseWheelScrollSensitivity: IEditorOption<EditorOption.mouseWheelScrollSensitivity, number>;
mouseWheelZoom: IEditorOption<EditorOption.mouseWheelZoom, boolean>;
@ -4303,7 +4316,7 @@ declare namespace monaco.editor {
overviewRulerBorder: IEditorOption<EditorOption.overviewRulerBorder, boolean>;
overviewRulerLanes: IEditorOption<EditorOption.overviewRulerLanes, number>;
padding: IEditorOption<EditorOption.padding, InternalEditorPaddingOptions>;
parameterHints: IEditorOption<EditorOption.parameterHints, InternalParameterHintOptions>;
parameterHints: IEditorOption<EditorOption.parameterHints, Readonly<Required<IEditorParameterHintOptions>>>;
peekWidgetDefaultFocus: IEditorOption<EditorOption.peekWidgetDefaultFocus, 'tree' | 'editor'>;
definitionLinkOpensInPeek: IEditorOption<EditorOption.definitionLinkOpensInPeek, boolean>;
quickSuggestions: IEditorOption<EditorOption.quickSuggestions, ValidQuickSuggestionsOptions>;
@ -4311,7 +4324,6 @@ declare namespace monaco.editor {
readOnly: IEditorOption<EditorOption.readOnly, boolean>;
renameOnType: IEditorOption<EditorOption.renameOnType, boolean>;
renderControlCharacters: IEditorOption<EditorOption.renderControlCharacters, boolean>;
renderIndentGuides: IEditorOption<EditorOption.renderIndentGuides, boolean>;
renderFinalNewline: IEditorOption<EditorOption.renderFinalNewline, boolean>;
renderLineHighlight: IEditorOption<EditorOption.renderLineHighlight, 'all' | 'line' | 'none' | 'gutter'>;
renderLineHighlightOnlyWhenFocus: IEditorOption<EditorOption.renderLineHighlightOnlyWhenFocus, boolean>;
@ -4330,13 +4342,13 @@ declare namespace monaco.editor {
showFoldingControls: IEditorOption<EditorOption.showFoldingControls, 'always' | 'mouseover'>;
showUnused: IEditorOption<EditorOption.showUnused, boolean>;
showDeprecated: IEditorOption<EditorOption.showDeprecated, boolean>;
inlayHints: IEditorOption<EditorOption.inlayHints, any>;
inlayHints: IEditorOption<EditorOption.inlayHints, Readonly<Required<IEditorInlayHintsOptions>>>;
snippetSuggestions: IEditorOption<EditorOption.snippetSuggestions, 'none' | 'top' | 'bottom' | 'inline'>;
smartSelect: IEditorOption<EditorOption.smartSelect, any>;
smartSelect: IEditorOption<EditorOption.smartSelect, Readonly<Required<ISmartSelectOptions>>>;
smoothScrolling: IEditorOption<EditorOption.smoothScrolling, boolean>;
stopRenderingLineAfter: IEditorOption<EditorOption.stopRenderingLineAfter, number>;
suggest: IEditorOption<EditorOption.suggest, InternalSuggestOptions>;
inlineSuggest: IEditorOption<EditorOption.inlineSuggest, any>;
suggest: IEditorOption<EditorOption.suggest, Readonly<Required<ISuggestOptions>>>;
inlineSuggest: IEditorOption<EditorOption.inlineSuggest, Readonly<Required<IInlineSuggestOptions>>>;
suggestFontSize: IEditorOption<EditorOption.suggestFontSize, number>;
suggestLineHeight: IEditorOption<EditorOption.suggestLineHeight, number>;
suggestOnTriggerCharacters: IEditorOption<EditorOption.suggestOnTriggerCharacters, boolean>;
@ -4706,6 +4718,19 @@ declare namespace monaco.editor {
* Defaults to an internal DOM node.
*/
overflowWidgetsDomNode?: HTMLElement;
/**
* Aria label for original editor.
*/
originalAriaLabel?: string;
/**
* Aria label for modified editor.
*/
modifiedAriaLabel?: string;
/**
* Is the diff editor inside another editor
* Defaults to false
*/
isInEmbeddedEditor?: boolean;
}
/**
@ -5451,6 +5476,10 @@ declare namespace monaco.languages {
* Provide commands for the given document and range.
*/
provideCodeActions(model: editor.ITextModel, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<CodeActionList>;
/**
* Given a code action fill in the edit. Will only invoked when missing.
*/
resolveCodeAction?(codeAction: CodeAction, token: CancellationToken): ProviderResult<CodeAction>;
}
/**

295
website/playground/monaco.d.ts.txt
View file

@ -414,6 +414,7 @@ declare namespace monaco {
readonly value: string;
readonly isTrusted?: boolean;
readonly supportThemeIcons?: boolean;
readonly supportHtml?: boolean;
uris?: {
[href: string]: UriComponents;
};
@ -871,7 +872,7 @@ declare namespace monaco.editor {
* `domElement` should be empty (not contain other dom nodes).
* The editor will read the size of `domElement`.
*/
export function createDiffEditor(domElement: HTMLElement, options?: IDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;
export function createDiffEditor(domElement: HTMLElement, options?: IStandaloneDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;
export interface IDiffNavigatorOptions {
readonly followsCaret?: boolean;
@ -1184,12 +1185,12 @@ declare namespace monaco.editor {
model?: ITextModel | null;
/**
* The initial value of the auto created model in the editor.
* To not create automatically a model, use `model: null`.
* To not automatically create a model, use `model: null`.
*/
value?: string;
/**
* The initial language of the auto created model in the editor.
* To not create automatically a model, use `model: null`.
* To not automatically create a model, use `model: null`.
*/
language?: string;
/**
@ -1212,12 +1213,17 @@ declare namespace monaco.editor {
* Defaults to "https://go.microsoft.com/fwlink/?linkid=852450"
*/
accessibilityHelpUrl?: string;
/**
* Container element to use for ARIA messages.
* Defaults to document.body.
*/
ariaContainerElement?: HTMLElement;
}
/**
* The options to create a diff editor.
*/
export interface IDiffEditorConstructionOptions extends IDiffEditorOptions {
export interface IStandaloneDiffEditorConstructionOptions extends IDiffEditorConstructionOptions {
/**
* Initial theme to be used for rendering.
* The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'.
@ -3216,16 +3222,6 @@ declare namespace monaco.editor {
* Defaults to false.
*/
renderControlCharacters?: boolean;
/**
* Enable rendering of indent guides.
* Defaults to true.
*/
renderIndentGuides?: boolean;
/**
* Enable highlighting of the active indent guide.
* Defaults to true.
*/
highlightActiveIndentGuide?: boolean;
/**
* Enable rendering of current line highlight.
* Defaults to all.
@ -3286,12 +3282,13 @@ declare namespace monaco.editor {
* Control if the editor should use shadow DOM.
*/
useShadowDOM?: boolean;
/**
* Controls the behavior of editor guides.
*/
guides?: IGuidesOptions;
}
/**
* Configuration options for the diff editor.
*/
export interface IDiffEditorOptions extends IEditorOptions {
export interface IDiffEditorBaseOptions {
/**
* Allow the user to resize the diff editor split view.
* Defaults to true.
@ -3307,6 +3304,11 @@ declare namespace monaco.editor {
* Defaults to 5000.
*/
maxComputationTime?: number;
/**
* Maximum supported file size in MB.
* Defaults to 50.
*/
maxFileSize?: number;
/**
* Compute the diff by ignoring leading/trailing whitespace
* Defaults to true.
@ -3327,11 +3329,6 @@ declare namespace monaco.editor {
* Defaults to false.
*/
diffCodeLens?: boolean;
/**
* Is the diff editor inside another editor
* Defaults to false
*/
isInEmbeddedEditor?: boolean;
/**
* Is the diff editor should render overview ruler
* Defaults to true
@ -3341,14 +3338,12 @@ declare namespace monaco.editor {
* Control the wrapping of the diff editor.
*/
diffWordWrap?: 'off' | 'on' | 'inherit';
/**
* Aria label for original editor.
*/
originalAriaLabel?: string;
/**
* Aria label for modified editor.
*/
modifiedAriaLabel?: string;
}
/**
* Configuration options for the diff editor.
*/
export interface IDiffEditorOptions extends IEditorOptions, IDiffEditorBaseOptions {
}
/**
@ -3898,6 +3893,25 @@ declare namespace monaco.editor {
export type InternalBracketPairColorizationOptions = Readonly<Required<IBracketPairColorizationOptions>>;
export interface IGuidesOptions {
/**
* Enable rendering of bracket pair guides.
*/
bracketPairs?: boolean;
/**
* Enable rendering of indent guides.
* Defaults to true.
*/
indentation?: boolean;
/**
* Enable highlighting of the active indent guide.
* Defaults to true.
*/
highlightActiveIndentation?: boolean;
}
export type InternalGuidesOptions = Readonly<Required<IGuidesOptions>>;
/**
* Configuration options for editor suggest widget
*/
@ -4107,45 +4121,45 @@ declare namespace monaco.editor {
automaticLayout = 10,
autoSurround = 11,
bracketPairColorization = 12,
codeLens = 13,
codeLensFontFamily = 14,
codeLensFontSize = 15,
colorDecorators = 16,
columnSelection = 17,
comments = 18,
contextmenu = 19,
copyWithSyntaxHighlighting = 20,
cursorBlinking = 21,
cursorSmoothCaretAnimation = 22,
cursorStyle = 23,
cursorSurroundingLines = 24,
cursorSurroundingLinesStyle = 25,
cursorWidth = 26,
disableLayerHinting = 27,
disableMonospaceOptimizations = 28,
domReadOnly = 29,
dragAndDrop = 30,
emptySelectionClipboard = 31,
extraEditorClassName = 32,
fastScrollSensitivity = 33,
find = 34,
fixedOverflowWidgets = 35,
folding = 36,
foldingStrategy = 37,
foldingHighlight = 38,
foldingImportsByDefault = 39,
unfoldOnClickAfterEndOfLine = 40,
fontFamily = 41,
fontInfo = 42,
fontLigatures = 43,
fontSize = 44,
fontWeight = 45,
formatOnPaste = 46,
formatOnType = 47,
glyphMargin = 48,
gotoLocation = 49,
hideCursorInOverviewRuler = 50,
highlightActiveIndentGuide = 51,
guides = 13,
codeLens = 14,
codeLensFontFamily = 15,
codeLensFontSize = 16,
colorDecorators = 17,
columnSelection = 18,
comments = 19,
contextmenu = 20,
copyWithSyntaxHighlighting = 21,
cursorBlinking = 22,
cursorSmoothCaretAnimation = 23,
cursorStyle = 24,
cursorSurroundingLines = 25,
cursorSurroundingLinesStyle = 26,
cursorWidth = 27,
disableLayerHinting = 28,
disableMonospaceOptimizations = 29,
domReadOnly = 30,
dragAndDrop = 31,
emptySelectionClipboard = 32,
extraEditorClassName = 33,
fastScrollSensitivity = 34,
find = 35,
fixedOverflowWidgets = 36,
folding = 37,
foldingStrategy = 38,
foldingHighlight = 39,
foldingImportsByDefault = 40,
unfoldOnClickAfterEndOfLine = 41,
fontFamily = 42,
fontInfo = 43,
fontLigatures = 44,
fontSize = 45,
fontWeight = 46,
formatOnPaste = 47,
formatOnType = 48,
glyphMargin = 49,
gotoLocation = 50,
hideCursorInOverviewRuler = 51,
hover = 52,
inDiffEditor = 53,
inlineSuggest = 54,
@ -4177,55 +4191,54 @@ declare namespace monaco.editor {
readOnly = 80,
renameOnType = 81,
renderControlCharacters = 82,
renderIndentGuides = 83,
renderFinalNewline = 84,
renderLineHighlight = 85,
renderLineHighlightOnlyWhenFocus = 86,
renderValidationDecorations = 87,
renderWhitespace = 88,
revealHorizontalRightPadding = 89,
roundedSelection = 90,
rulers = 91,
scrollbar = 92,
scrollBeyondLastColumn = 93,
scrollBeyondLastLine = 94,
scrollPredominantAxis = 95,
selectionClipboard = 96,
selectionHighlight = 97,
selectOnLineNumbers = 98,
showFoldingControls = 99,
showUnused = 100,
snippetSuggestions = 101,
smartSelect = 102,
smoothScrolling = 103,
stickyTabStops = 104,
stopRenderingLineAfter = 105,
suggest = 106,
suggestFontSize = 107,
suggestLineHeight = 108,
suggestOnTriggerCharacters = 109,
suggestSelection = 110,
tabCompletion = 111,
tabIndex = 112,
unusualLineTerminators = 113,
useShadowDOM = 114,
useTabStops = 115,
wordSeparators = 116,
wordWrap = 117,
wordWrapBreakAfterCharacters = 118,
wordWrapBreakBeforeCharacters = 119,
wordWrapColumn = 120,
wordWrapOverride1 = 121,
wordWrapOverride2 = 122,
wrappingIndent = 123,
wrappingStrategy = 124,
showDeprecated = 125,
inlayHints = 126,
editorClassName = 127,
pixelRatio = 128,
tabFocusMode = 129,
layoutInfo = 130,
wrappingInfo = 131
renderFinalNewline = 83,
renderLineHighlight = 84,
renderLineHighlightOnlyWhenFocus = 85,
renderValidationDecorations = 86,
renderWhitespace = 87,
revealHorizontalRightPadding = 88,
roundedSelection = 89,
rulers = 90,
scrollbar = 91,
scrollBeyondLastColumn = 92,
scrollBeyondLastLine = 93,
scrollPredominantAxis = 94,
selectionClipboard = 95,
selectionHighlight = 96,
selectOnLineNumbers = 97,
showFoldingControls = 98,
showUnused = 99,
snippetSuggestions = 100,
smartSelect = 101,
smoothScrolling = 102,
stickyTabStops = 103,
stopRenderingLineAfter = 104,
suggest = 105,
suggestFontSize = 106,
suggestLineHeight = 107,
suggestOnTriggerCharacters = 108,
suggestSelection = 109,
tabCompletion = 110,
tabIndex = 111,
unusualLineTerminators = 112,
useShadowDOM = 113,
useTabStops = 114,
wordSeparators = 115,
wordWrap = 116,
wordWrapBreakAfterCharacters = 117,
wordWrapBreakBeforeCharacters = 118,
wordWrapColumn = 119,
wordWrapOverride1 = 120,
wordWrapOverride2 = 121,
wrappingIndent = 122,
wrappingStrategy = 123,
showDeprecated = 124,
inlayHints = 125,
editorClassName = 126,
pixelRatio = 127,
tabFocusMode = 128,
layoutInfo = 129,
wrappingInfo = 130
}
export const EditorOptions: {
acceptSuggestionOnCommitCharacter: IEditorOption<EditorOption.acceptSuggestionOnCommitCharacter, boolean>;
@ -4240,14 +4253,15 @@ declare namespace monaco.editor {
autoIndent: IEditorOption<EditorOption.autoIndent, EditorAutoIndentStrategy>;
automaticLayout: IEditorOption<EditorOption.automaticLayout, boolean>;
autoSurround: IEditorOption<EditorOption.autoSurround, 'languageDefined' | 'never' | 'quotes' | 'brackets'>;
bracketPairColorization: IEditorOption<EditorOption.bracketPairColorization, any>;
bracketPairColorization: IEditorOption<EditorOption.bracketPairColorization, Readonly<Required<IBracketPairColorizationOptions>>>;
bracketPairGuides: IEditorOption<EditorOption.guides, Readonly<Required<IGuidesOptions>>>;
stickyTabStops: IEditorOption<EditorOption.stickyTabStops, boolean>;
codeLens: IEditorOption<EditorOption.codeLens, boolean>;
codeLensFontFamily: IEditorOption<EditorOption.codeLensFontFamily, string>;
codeLensFontSize: IEditorOption<EditorOption.codeLensFontSize, number>;
colorDecorators: IEditorOption<EditorOption.colorDecorators, boolean>;
columnSelection: IEditorOption<EditorOption.columnSelection, boolean>;
comments: IEditorOption<EditorOption.comments, EditorCommentsOptions>;
comments: IEditorOption<EditorOption.comments, Readonly<Required<IEditorCommentsOptions>>>;
contextmenu: IEditorOption<EditorOption.contextmenu, boolean>;
copyWithSyntaxHighlighting: IEditorOption<EditorOption.copyWithSyntaxHighlighting, boolean>;
cursorBlinking: IEditorOption<EditorOption.cursorBlinking, TextEditorCursorBlinkingStyle>;
@ -4263,7 +4277,7 @@ declare namespace monaco.editor {
emptySelectionClipboard: IEditorOption<EditorOption.emptySelectionClipboard, boolean>;
extraEditorClassName: IEditorOption<EditorOption.extraEditorClassName, string>;
fastScrollSensitivity: IEditorOption<EditorOption.fastScrollSensitivity, number>;
find: IEditorOption<EditorOption.find, EditorFindOptions>;
find: IEditorOption<EditorOption.find, Readonly<Required<IEditorFindOptions>>>;
fixedOverflowWidgets: IEditorOption<EditorOption.fixedOverflowWidgets, boolean>;
folding: IEditorOption<EditorOption.folding, boolean>;
foldingStrategy: IEditorOption<EditorOption.foldingStrategy, 'auto' | 'indentation'>;
@ -4278,13 +4292,12 @@ declare namespace monaco.editor {
formatOnPaste: IEditorOption<EditorOption.formatOnPaste, boolean>;
formatOnType: IEditorOption<EditorOption.formatOnType, boolean>;
glyphMargin: IEditorOption<EditorOption.glyphMargin, boolean>;
gotoLocation: IEditorOption<EditorOption.gotoLocation, GoToLocationOptions>;
gotoLocation: IEditorOption<EditorOption.gotoLocation, Readonly<Required<IGotoLocationOptions>>>;
hideCursorInOverviewRuler: IEditorOption<EditorOption.hideCursorInOverviewRuler, boolean>;
highlightActiveIndentGuide: IEditorOption<EditorOption.highlightActiveIndentGuide, boolean>;
hover: IEditorOption<EditorOption.hover, EditorHoverOptions>;
hover: IEditorOption<EditorOption.hover, Readonly<Required<IEditorHoverOptions>>>;
inDiffEditor: IEditorOption<EditorOption.inDiffEditor, boolean>;
letterSpacing: IEditorOption<EditorOption.letterSpacing, number>;
lightbulb: IEditorOption<EditorOption.lightbulb, EditorLightbulbOptions>;
lightbulb: IEditorOption<EditorOption.lightbulb, Readonly<Required<IEditorLightbulbOptions>>>;
lineDecorationsWidth: IEditorOption<EditorOption.lineDecorationsWidth, string | number>;
lineHeight: IEditorOption<EditorOption.lineHeight, number>;
lineNumbers: IEditorOption<EditorOption.lineNumbers, InternalEditorRenderLineNumbersOptions>;
@ -4292,7 +4305,7 @@ declare namespace monaco.editor {
linkedEditing: IEditorOption<EditorOption.linkedEditing, boolean>;
links: IEditorOption<EditorOption.links, boolean>;
matchBrackets: IEditorOption<EditorOption.matchBrackets, 'always' | 'never' | 'near'>;
minimap: IEditorOption<EditorOption.minimap, EditorMinimapOptions>;
minimap: IEditorOption<EditorOption.minimap, Readonly<Required<IEditorMinimapOptions>>>;
mouseStyle: IEditorOption<EditorOption.mouseStyle, 'default' | 'text' | 'copy'>;
mouseWheelScrollSensitivity: IEditorOption<EditorOption.mouseWheelScrollSensitivity, number>;
mouseWheelZoom: IEditorOption<EditorOption.mouseWheelZoom, boolean>;
@ -4303,7 +4316,7 @@ declare namespace monaco.editor {
overviewRulerBorder: IEditorOption<EditorOption.overviewRulerBorder, boolean>;
overviewRulerLanes: IEditorOption<EditorOption.overviewRulerLanes, number>;
padding: IEditorOption<EditorOption.padding, InternalEditorPaddingOptions>;
parameterHints: IEditorOption<EditorOption.parameterHints, InternalParameterHintOptions>;
parameterHints: IEditorOption<EditorOption.parameterHints, Readonly<Required<IEditorParameterHintOptions>>>;
peekWidgetDefaultFocus: IEditorOption<EditorOption.peekWidgetDefaultFocus, 'tree' | 'editor'>;
definitionLinkOpensInPeek: IEditorOption<EditorOption.definitionLinkOpensInPeek, boolean>;
quickSuggestions: IEditorOption<EditorOption.quickSuggestions, ValidQuickSuggestionsOptions>;
@ -4311,7 +4324,6 @@ declare namespace monaco.editor {
readOnly: IEditorOption<EditorOption.readOnly, boolean>;
renameOnType: IEditorOption<EditorOption.renameOnType, boolean>;
renderControlCharacters: IEditorOption<EditorOption.renderControlCharacters, boolean>;
renderIndentGuides: IEditorOption<EditorOption.renderIndentGuides, boolean>;
renderFinalNewline: IEditorOption<EditorOption.renderFinalNewline, boolean>;
renderLineHighlight: IEditorOption<EditorOption.renderLineHighlight, 'all' | 'line' | 'none' | 'gutter'>;
renderLineHighlightOnlyWhenFocus: IEditorOption<EditorOption.renderLineHighlightOnlyWhenFocus, boolean>;
@ -4330,13 +4342,13 @@ declare namespace monaco.editor {
showFoldingControls: IEditorOption<EditorOption.showFoldingControls, 'always' | 'mouseover'>;
showUnused: IEditorOption<EditorOption.showUnused, boolean>;
showDeprecated: IEditorOption<EditorOption.showDeprecated, boolean>;
inlayHints: IEditorOption<EditorOption.inlayHints, any>;
inlayHints: IEditorOption<EditorOption.inlayHints, Readonly<Required<IEditorInlayHintsOptions>>>;
snippetSuggestions: IEditorOption<EditorOption.snippetSuggestions, 'none' | 'top' | 'bottom' | 'inline'>;
smartSelect: IEditorOption<EditorOption.smartSelect, any>;
smartSelect: IEditorOption<EditorOption.smartSelect, Readonly<Required<ISmartSelectOptions>>>;
smoothScrolling: IEditorOption<EditorOption.smoothScrolling, boolean>;
stopRenderingLineAfter: IEditorOption<EditorOption.stopRenderingLineAfter, number>;
suggest: IEditorOption<EditorOption.suggest, InternalSuggestOptions>;
inlineSuggest: IEditorOption<EditorOption.inlineSuggest, any>;
suggest: IEditorOption<EditorOption.suggest, Readonly<Required<ISuggestOptions>>>;
inlineSuggest: IEditorOption<EditorOption.inlineSuggest, Readonly<Required<IInlineSuggestOptions>>>;
suggestFontSize: IEditorOption<EditorOption.suggestFontSize, number>;
suggestLineHeight: IEditorOption<EditorOption.suggestLineHeight, number>;
suggestOnTriggerCharacters: IEditorOption<EditorOption.suggestOnTriggerCharacters, boolean>;
@ -4706,6 +4718,19 @@ declare namespace monaco.editor {
* Defaults to an internal DOM node.
*/
overflowWidgetsDomNode?: HTMLElement;
/**
* Aria label for original editor.
*/
originalAriaLabel?: string;
/**
* Aria label for modified editor.
*/
modifiedAriaLabel?: string;
/**
* Is the diff editor inside another editor
* Defaults to false
*/
isInEmbeddedEditor?: boolean;
}
/**
@ -5451,6 +5476,10 @@ declare namespace monaco.languages {
* Provide commands for the given document and range.
*/
provideCodeActions(model: editor.ITextModel, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<CodeActionList>;
/**
* Given a code action fill in the edit. Will only invoked when missing.
*/
resolveCodeAction?(codeAction: CodeAction, token: CancellationToken): ProviderResult<CodeAction>;
}
/**