The first version of our extension contributes a command called catCoding.start. You can find the complete code for the example app here. Here's the package.json for the first version of the Cat Coding extension. As we work through the API, we'll continue adding functionality to the extension, including a counter that keeps track of how many lines of source code our cat has written and notifications that inform the user when the cat introduces a bug. This extension will use a webview to show a gif of a cat writing some code (presumably in VS Code). To explain the webview API, we are going to build a simple extension called Cat Coding. However, if you are confident that you need to use webviews, then this document is here to help. Remember: Just because you can do something with webviews, doesn't mean you should. Will your webview add enough user value to justify its high resource cost? Is a webview the only way to implement your feature? Can you use the regular VS Code APIs instead? A poorly designed webview can also easily feel out of place within VS Code.īefore using a webview, please consider the following:ĭoes this functionality really need to live within VS Code? Would it be better as a separate application or website? Webviews are resource heavy and run in a separate context from normal extensions. Webviews are pretty amazing, but they should also be used sparingly and only when VS Code's native API is inadequate. Even if you are more interested in those APIs, we recommend reading through this page first to familiarize yourself with the webview basics. This page focuses on the basic webview panel API, although almost everything covered here applies to the webviews used in custom editors and webview views as well. See the webview view sample extension for more details.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |