Closes #4084
This commit is contained in:
Remco Haszing 2023-07-18 14:51:18 +02:00
Родитель be57cbf4ef
Коммит 7dac0d0a2e
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 40D9F5FE9155FD3C
1 изменённых файлов: 26 добавлений и 0 удалений

Просмотреть файл

@ -31,6 +31,32 @@ You will get:
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, its 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. Its 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 doesnt 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 its 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, also known as IntelliSense. For example, this includes completion and hover information. It is not the same as, but often maps to [language server protocol](https://microsoft.github.io/language-server-protocol) features.
Providers work on models. Some IntelliSense 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 its 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. And editors are typically disposed when changing to another view.
## Documentation
- Learn how to integrate the editor with these [complete samples](./samples/).