For example, VS Code needs to know what types of files your custom editor works with as well as how to identify your custom editor in any UI. The customEditors contribution point is how your extension tells VS Code about the custom editors that it provides. When trying to decide which type of custom editor to use, the decision is usually simple: if you are working with a text based file format use CustomTextEditorProvider, for binary file formats use CustomEditorProvider. You can skip over much of this complexity if your custom editor is readonly, such as custom editors for previews. This means that you can use a CustomEditor for binary formats such as images, but it also means that your extension is responsible for a lot more, including implementing save and backing. With a CustomEditorProvider on the other hand, your extension brings its own document model. CustomTextEditor are considerably easier to implement because VS Code already knows how to work with text files and can therefore implement operations such as save and backing up files for hot exit. You can use a CustomTextEditor for any text based file types. The main difference between these is how they define their document model.Ī CustomTextEditorProvider uses VS Code's standard TextDocument as its data model. There are two classes of custom editors: custom text editors and custom editors. In this case, there is still just a single TextDocument since there is still just a single copy of the resource in the workspace, but there are now two webviews for that resource. For example, imagine that you open a file that has a CustomTextEditorProvider and then run the View: Split editor command. CustomReadonlyEditorProvider and CustomEditorProvider on the other hand let you provide your own document model, which lets them be used for non-text file formats.Ĭustom editors have a single document model per resource but there may be multiple editor instances (views) of this document. A CustomTextEditorProvider uses VS Code's standard TextDocument as its document model and all changes to the file are expressed using VS Code's standard text editing APIs. This model is how your extension understands the resource (file) it is working with. The other part of a custom editor is the document model. Check out our webview documentation for more information on webviews and best practices for working with them. Webviews cannot access the VS Code API directly but they can talk with extensions by passing messages back and forth. This lets you build the user interface of your custom editor using standard HTML, CSS, and JavaScript. The view side of a custom editor is implemented using a webview. There are two parts to a custom editor: the view that users interact with and the document model that your extension uses to interact with the underlying resource.
LinksĪ custom editor is an alternative view that is shown in place of VS Code's standard text editor for specific resources.
#Opml editor online download
Custom editors build on a lot of VS Code concepts-such as webviews and text documents-so it may be a bit overwhelming if you are learning all of these new ideas at the same time.īut if you're feeling ready and are thinking about all the cool custom editors you are going to build, then let's get started! Be sure to download the custom editor extension sample so you can follow along with the documentation and see how the custom editor API comes together. Then for each of these custom editor types, we'll cover the basics of building a well behaved custom editor.Īlthough custom editors are a powerful new extension point, implementing a basic custom editor is not actually that difficult! Still, if you are working on your first VS Code extension, you may want to consider holding off on diving into custom editors until you are more familiar with the basics of the VS Code API. We'll take a look at the two types of custom editors and how they differ, as well as which one is right for your use case. This document provides an overview of the custom editor API and the basics of implementing a custom editor. Building fully customizable editing experiences for binary or text files.Offering alternative visual renderings for data files such as CSV or JSON or XML.Creating WYSIWYG editors for languages such as Markdown or XAML.Previewing assets, such as shaders or 3D models, directly in VS Code.They have a wide variety of use cases, such as: Custom editors allow extensions to create fully customizable read/write editors that are used in place of VS Code's standard text editor for specific types of resources.
0 kommentar(er)
