Files
vscode-extension-samples/webview-sample/README.md
2018-06-28 16:39:29 -07:00

876 B

Cat Coding — A Webview API Sample

Demonstrates VS Code's webview API. This includes:

  • Creating and showing a basic webview.
  • Dynamically updating a webview's content.
  • Loading local content in a webview.
  • Running scripts in a webview.
  • Sending message from an extension to a webview.
  • Sending messages from a webview to an extension.
  • Using a basic content security policy.
  • Webview lifecycle and handling dispose.
  • Saving and restoring state when the panel goes into the background. (Requires VS Code 1.25+)
  • Serialization and persistence across VS Code reboots. (Requires VS Code 1.25+)

Running the example

  • Open this example in VS Code 1.23+
  • npm install
  • npm run watch or npm run compile
  • F5 to start debugging

Run the Cat Coding: Start cat coding session to create the webview.