monaco-editor
Advanced tools
The monaco-editor npm package provides the code editor that powers VS Code, offering rich IntelliSense, validation for a variety of languages, and advanced editing features. It can be integrated into web applications to provide a full-fledged code editing experience.
Syntax highlighting and IntelliSense
This code initializes the Monaco Editor with JavaScript syntax highlighting and IntelliSense support.
var editor = monaco.editor.create(document.getElementById('container'), {
value: 'function x() {\n console.log("Hello world!");\n}',
language: 'javascript'
});Code validation and linting
This code adds a marker to the editor model, indicating an error at the specified position with a message.
monaco.editor.setModelMarkers(editor.getModel(), 'owner', [
{ startLineNumber: 1, startColumn: 1, endLineNumber: 1, endColumn: 1, message: 'Error message', severity: monaco.MarkerSeverity.Error }
]);Custom themes
This code defines a custom theme for the editor and applies it.
monaco.editor.defineTheme('myTheme', {
base: 'vs',
inherit: true,
rules: [{ background: 'EDF9FA' }],
colors: { 'editor.foreground': '#000000' }
});
monaco.editor.setTheme('myTheme');Keybindings and editor actions
This code adds a custom action to the editor that can be triggered with a keyboard shortcut.
editor.addAction({
id: 'my-unique-id',
label: 'My Label',
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.KEY_S],
run: function(ed) {
alert('Action triggered!');
}
});Ace is a standalone code editor written in JavaScript. It is similar to monaco-editor but with a different API and less out-of-the-box language support. Ace is lightweight and can be easier to integrate into existing projects.
CodeMirror is another browser-based code editor with features like syntax highlighting, a rich API, and various language modes. It is less resource-intensive than monaco-editor and is often used in scenarios where performance is critical.
Brace is a fork of Ace that packages the editor for use with browserify, which can make it easier to use with npm and Node.js-based build systems. It offers similar functionality to Ace.
The Monaco Editor is the code editor which powers VS Code, with the features better described here.
Please note that this repository contains no source code for the code editor, it only contains the scripts to package everything together and ship the monaco-editor npm module.
Try the editor out on our website.
$ npm install monaco-editor
You will get:
esm: ESM version of the editor (compatible with e.g. webpack)dev: AMD bundled, not minifiedmin: AMD bundled, and minifiedmin-maps: source maps for minmonaco.d.ts: this specifies the API of the editor (this is what is actually versioned, everything else is considered private and might break with any release).It is recommended to develop against the dev version, and in production to use the min version.
monaco.d.ts.Create issues in this repository for anything related to the Monaco Editor. Always mention the version of the editor when creating issues and the browser you're having trouble in. Please search for existing issues to avoid duplicates.
❓ What is the relationship between VS Code and the Monaco Editor?
The Monaco Editor is generated straight from VS Code's sources with some shims around services the code needs to make it run in a web browser outside of its home.
❓ What is the relationship between VS Code's version and the Monaco Editor's version?
None. The Monaco Editor is a library and it reflects directly the source code.
❓ I've written an extension for VS Code, will it work on the Monaco Editor in a browser?
No.
Note: If the extension is fully based on the LSP and if the language server is authored in JavaScript, then it would be possible.
❓ Why all these web workers and why should I care?
Language services create web workers to compute heavy stuff outside of the UI thread. They cost hardly anything in terms of resource overhead and you shouldn't worry too much about them, as long as you get them to work (see above the cross-domain case).
❓ What is this loader.js? Can I use require.js?
It is an AMD loader that we use in VS Code. Yes.
❓ I see the warning "Could not create web worker". What should I do?
HTML5 does not allow pages loaded on file:// to create web workers. Please load the editor with a web server on http:// or https:// schemes. Please also see the cross-domain case above.
❓ Is the editor supported in mobile browsers or mobile web app frameworks?
No.
❓ Why doesn't the editor support TextMate grammars?
❓ What about IE 11 support?
0.18.1.Please see CONTRIBUTING
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Licensed under the MIT License.
[0.21.0] (21.09.2020)
Paste in the context menu in browsers which support the clipboard API.monaco-typescript: support for "deprecated" tags, API to participate in the web worker, improved lib.d.ts resolving.overflowWidgetsDomNode constructor option to pass in a parent for overflowing widgets.minimap.size option: proportional, fill, fit.OnTypeRename provider and option renameOnType.automaticLayout.tabIndex, scrollPredominantAxis, columnSelection, padding, unfoldOnClickAfterEndOfLine, renderLineHighlightOnlyWhenFocus, definitionLinkOpensInPeek, showDeprecated, comments.ignoreEmptyLines, find.cursorMoveOnType, find.loop.originalCodeLens, modifiedCodeLens.rulers can now define different colors, renderWhitespace can now be trailing.CompletionItemLabel.signature has been renamed to CompletionItemLabel.parameters.CompletionItemProvider.resolveCompletionItem has changed.IMarker.code.link was renamed to IMarker.code.target.IMarkerData.code.link was renamed to IMarkerData.code.target.EditorLayoutInfo has been restructured.Contributions to monaco-editor:
Contributions to monaco-typescript:
Contributions to monaco-json:
Contributions to monaco-languages:
FAQs
A browser based code editor
The npm package monaco-editor receives a total of 1,192,129 weekly downloads. As such, monaco-editor popularity was classified as popular.
We found that monaco-editor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."