mirror of
https://github.com/microsoft/vscode-extension-samples.git
synced 2026-06-13 07:10:26 +08:00
1a6bac6dd9
Adds an example extension for custom editors. This example extension shows two custom editors: one for text and one for binary files
23 lines
891 B
Markdown
23 lines
891 B
Markdown
# Cat Customs - Custom Editor API Samples
|
|
|
|
Demonstrates VS Code's [custom editor API](TODO) using two custom editors:
|
|
|
|
- Cat Scratch — A text based custom editor for `.cscratch` files (which are just json files)
|
|
- Paw Draw - A binary custom editor for `.pawdraw` files (which are just jpeg files with a different file extension)
|
|
|
|
## VS Code API
|
|
|
|
### `vscode` module
|
|
|
|
- [`window.registerCustomEditorProvider`](https://code.visualstudio.com/api/references/vscode-api#window.registerCustomEditorProvider)
|
|
- [`CustomTextEditor`](https://code.visualstudio.com/api/references/vscode-api#CustomTextEditor)
|
|
- [`CustomEditor`](https://code.visualstudio.com/api/references/vscode-api#CustomEditor)
|
|
|
|
## Running the example
|
|
|
|
- Open this example in VS Code 1.44+
|
|
- `npm install`
|
|
- `npm run watch` or `npm run compile`
|
|
- `F5` to start debugging
|
|
|
|
Open the example files from the `exampleFiles` directory. |