0.52.0 • Published 3 months ago

monaco-editor v0.52.0

Weekly downloads
298,815
License
MIT
Repository
github
Last release
3 months ago

Monaco Editor

Versions Versions Feature Requests Bugs

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)
  • inside /dev: AMD bundled, not minified
  • inside /min: AMD bundled, and minified
  • inside /min-maps: source maps for min
  • 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).

It is recommended to develop against the dev version, and in production to use the min version.

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 resource is no longer needed. For example, calling model.dispose() will unregister it, freeing up the URI for a new model. Editors should be disposed to free up resources and remove their model listeners.

Documentation

Issues

Create issues in this repository for anything related to the Monaco Editor. Please search for existing issues to avoid duplicates.

FAQ

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.

Is the editor supported in mobile browsers or mobile web app frameworks?

No.

Why doesn't the editor support TextMate grammars?

Contributing / Local Development

We are welcoming contributions from the community! Please see CONTRIBUTING for details how you can contribute effectively, how you can run the editor from sources and how you can debug and fix issues.

Code of Conduct

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.

License

Licensed under the MIT License.

visualization1cf-designergdwebeditplattab-editoruse-calcite-monaco-editorgtl-editordt-ai-worksvida-cmsoxygenidecxqleditorstep-componentsligosnippetz@narratorai/monaco-markdown@caoyongmeng/ui-1czzn-form-designbigendianuifile-code-editorambients-monacohdtemplate-avue-form-designnuven-code-editorspaceone-consolemircoai-guiqjh-form-designscimetro-coresalesforce-query-editor-appauto-form-ipaasflowssssalesforce-query-editor-testmariadb-maxscale-query-editor@winwin/hexo-editor-clientgitbook-plugin-ts-exercisesgwt-avue-form-designsolanum-studio@chrisrowles/impaladci-rpa-designsmile-xin-amis@stacksoda/react-monaco-editorfastamismarsgis-editordxsix-form-components@mui/studio-app@cryptobash/kernelweb_relation@thtf/form-designer@ipu/checkformula-editplatformreact-web-ide-componentlg-ly-web-componentsveloce-componentssamuellangsunrise-x3d-editorartusview1asp-smart-layout123@dxsixpc/components@formlogic/component@vinvc/antd-setters@infinitebrahmanuniverse/nolb-mona@th-designable/react-settings-formmagic-editor-romayn1novaaa-plusmkeditordplus-guixdcorezxr-new-componentszxr-new-renderssx-best-low-codejswl-lowcode-scenejswl-lowcode-screenjswl-lowcode-system@everything-registry/sub-chunk-2195monaco-editor-file-tree@mega-apps/lowcode@xrhcc-ui/basepreact-monaco-editorwilliam1-ui-componentsstrapi-plugin-export-data@fabrikat/raum@bit74/pdql-autocomplete@code-preview/reactscx-adminscx-matrix-uijdlinker-systemjdlinker-weblane-testjdlinker-ui-componentsngx-monaco-editor-app@thiagoelg/kaoto-ui@tallman/react-utilities@playroom/playroomblockzie-guidabsi-payloadhigenhigen-libtask-components-dimptabidoo-libstaskbuilder-renderertandem-designertandemapptandemcodesynx-sdksyl-avue-form-design
0.52.0-rc2

3 months ago

0.52.0

3 months ago

0.51.0-rc3

4 months ago

0.51.0-rc2

4 months ago

0.49.0-rc

7 months ago

0.51.0-rc

4 months ago

0.50.0

6 months ago

0.50.0-rc

6 months ago

0.49.0

7 months ago

0.51.0

4 months ago

0.48.0

8 months ago

0.48.0-rc

8 months ago

0.47.0-dev-20240308

10 months ago

0.47.0-rc

10 months ago

0.47.0

10 months ago

0.47.0-dev-20240307

10 months ago

0.47.0-dev-20240306

10 months ago

0.47.0-dev-20240305

10 months ago

0.47.0-dev-20240304

10 months ago

0.47.0-dev-20240303

10 months ago

0.47.0-dev-20240302

10 months ago

0.47.0-dev-20240301

10 months ago

0.47.0-dev-20240229

10 months ago

0.47.0-dev-20240228

10 months ago

0.47.0-dev-20240227

10 months ago

0.47.0-dev-20240225

10 months ago

0.47.0-dev-20240224

10 months ago

0.47.0-dev-20240223

10 months ago

0.47.0-dev-20240222

10 months ago

0.47.0-dev-20240221

10 months ago

0.47.0-dev-20240220

10 months ago

0.47.0-dev-20240219

10 months ago

0.47.0-dev-20240218

10 months ago

0.47.0-dev-20240217

10 months ago

0.47.0-dev-20240216

10 months ago

0.47.0-dev-20240215

10 months ago

0.47.0-dev-20240214

10 months ago

0.47.0-dev-20240213

10 months ago

0.47.0-dev-20240212

10 months ago

0.47.0-dev-20240211

11 months ago

0.47.0-dev-20240210

11 months ago

0.47.0-dev-20240209

11 months ago

0.47.0-dev-20240208

11 months ago

0.46.0

11 months ago

0.46.0-rc

11 months ago

0.46.0-dev-20240207

11 months ago

0.46.0-dev-20240202

11 months ago

0.46.0-dev-20240201

11 months ago

0.46.0-dev-20240131

11 months ago

0.46.0-dev-20240130

11 months ago

0.46.0-dev-20240127

11 months ago

0.46.0-dev-20240129

11 months ago

0.46.0-dev-20240128

11 months ago

0.46.0-dev-20240126

11 months ago

0.46.0-dev-20240125

11 months ago

0.46.0-dev-20240124

11 months ago

0.46.0-dev-20240109

11 months ago

0.46.0-dev-20240116

11 months ago

0.46.0-dev-20240115

11 months ago

0.46.0-dev-20240118

11 months ago

0.46.0-dev-20240117

11 months ago

0.46.0-dev-20240119

11 months ago

0.46.0-dev-20240110

11 months ago

0.46.0-dev-20240112

11 months ago

0.46.0-dev-20240111

11 months ago

0.46.0-dev-20240114

11 months ago

0.46.0-dev-20240113

11 months ago

0.46.0-dev-20240121

11 months ago

0.46.0-dev-20240120

11 months ago

0.46.0-dev-20240123

11 months ago

0.46.0-dev-20240122

11 months ago

0.45.0

1 year ago

0.45.0-rc

1 year ago

0.44.0-rc1

1 year ago

0.44.0

1 year ago

0.43.0

1 year ago

0.42.0-rc1

1 year ago

0.41.0

1 year ago

0.41.0-rc1

1 year ago

0.39.0-rc2

2 years ago

0.39.0

2 years ago

0.40.0

1 year ago

0.38.0

2 years ago

0.36.1

2 years ago

0.36.0

2 years ago

0.37.1

2 years ago

0.37.0

2 years ago

0.35.0

2 years ago

0.34.1

2 years ago

0.34.0

2 years ago

0.33.0

3 years ago

0.32.1

3 years ago

0.32.0

3 years ago

0.31.1

3 years ago

0.31.0

3 years ago

0.30.1

3 years ago

0.30.0

3 years ago

0.29.0

3 years ago

0.29.1

3 years ago

0.28.1

3 years ago

0.28.0

3 years ago

0.27.0

3 years ago

0.26.1

3 years ago

0.26.0

3 years ago

0.25.2

4 years ago

0.25.1

4 years ago

0.25.0

4 years ago

0.24.0

4 years ago

0.23.0

4 years ago

0.22.3

4 years ago

0.22.2

4 years ago

0.22.1

4 years ago

0.22.0

4 years ago

0.21.3

4 years ago

0.21.2

4 years ago

0.21.1

4 years ago

0.21.0

4 years ago

0.20.0

5 years ago

0.19.3

5 years ago

0.19.1

5 years ago

0.19.2

5 years ago

0.19.0

5 years ago

0.18.1

5 years ago

0.18.0

5 years ago

0.17.1

6 years ago

0.17.0

6 years ago

0.16.2

6 years ago

0.16.1

6 years ago

0.16.0

6 years ago

0.15.6

6 years ago

0.15.5

6 years ago

0.15.4

6 years ago

0.15.3

6 years ago

0.15.2

6 years ago

0.15.1

6 years ago

0.15.0

6 years ago

0.14.3

6 years ago

0.14.2

6 years ago

0.14.1

6 years ago

0.14.0

6 years ago

0.13.1

7 years ago

0.13.0

7 years ago

0.12.0

7 years ago

0.11.1

7 years ago

0.11.0

7 years ago

0.10.1

7 years ago

0.10.0

7 years ago

0.9.0

7 years ago

0.8.3

8 years ago

0.8.2

8 years ago

0.8.1

8 years ago

0.8.0

8 years ago

0.7.0

8 years ago

0.6.1

8 years ago

0.6.0

8 years ago

0.5.3

8 years ago

0.5.1

9 years ago

0.5.0

9 years ago

0.4.0

9 years ago

0.3.1

9 years ago

0.2.4

9 years ago

0.2.3

9 years ago

0.0.1

9 years ago