README

Monaco Editor






The Monaco Editor is the fully featured code editor from VS Code. Check out the VS Code docs to see some of the supported features.

!image

 Try it out

Try out the editor and see various examples in our interactive playground.

The playground is the best way to learn about how to use the editor, which features is supports, to try out different versions and to create minimal reproducible examples for bug reports.

 Installing


 npm install monaco-editor


You will get:

- inside /esm: ESM version of the editor (compatible with e.g. webpack)
- monaco.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).

:warning: The monaco editor also ships an AMD build for backwards-compatibility reasons, but the AMD support is deprecated and will be removed in future versions.

 Localization

To load the editor in a specific language, make sure that the corresponding nls script file is loaded before the main monaco editor script. For example, to load the editor in German, include the following script tag:
html



Check the sources for available languages.

 Concepts

Monaco editor is best known for being the text editor that powers VS Code. However, it's a bit more nuanced. Some basic understanding about the underlying concepts is needed to use Monaco editor effectively.

 Models

Models are at the heart of Monaco editor. It's what you interact with when managing content. A model represents a file that has been opened. This could represent a file that exists on a file system, but it doesn't have to. For example, the model holds the text content, determines the language of the content, and tracks the edit history of the content.

 URIs

Each model is identified by a URI. This is why it's not possible for two models to have the same URI. Ideally when you represent content in Monaco editor, you should think of a virtual file system that matches the files your users are editing. For example, you could use file:/// as a base path. If a model is created without a URI, its URI will be inmemory://model/1. The number increases as more models are created.

 Editors

An editor is a user facing view of the model. This is what gets attached to the DOM and what your users see visually. Typical editor operations are displaying a model, managing the view state, or executing actions or commands.

 Providers

Providers provide smart editor features. For example, this includes completion and hover information. It is not the same as, but often maps to language server protocol features.

Providers work on models. Some smart features depends on the file URI. For example, for TypeScript to resolve imports, or for JSON IntelliSense to determine which JSON schema to apply to which model. So it's important to choose proper model URIs.

 Disposables

Many Monaco related objects often implement the .dispose() method. This method is intended to perform cleanups when a r

Top issues

Discussions

Latest release

Changes:

 5487: Prepare Monaco Editor 0.57.0 release
 5415: Bump uuid and webpack-dev-server in /website
 5476: Bump baseline-browser-mapping from 2.9.19 to 2.11.21 in /website
 5474: Bump svgo from 2.8.3 to 2.8.4 in /samples/browser-esm-parcel
 5479: Bump actions/deploy-pages from 5.0.0 to 5.0.1 in the github-actions group
 5468: Bump browserslist from 4.28.1 to 4.28.8 in /website
 5475: Bump js-yaml from 4.3.1 to 4.3.2
 5470: Bump fast-uri from 3.1.2 to 3.1.7 in /webpack-plugin
 5469: Bump nanoid from 3.3.11 to 3.3.18 in /webpack-plugin
 5467: Bump fast-uri from 3.1.5 to 3.1.7 in /samples/b