https://github.com/keyboarddrummer/webview-sample

https://github.com/keyboarddrummer/webview-sample

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/keyboarddrummer/webview-sample
• Owner: keyboardDrummer
• Created: 2020-08-18T18:31:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-18T18:34:44.000Z (over 4 years ago)
• Last Synced: 2024-11-29T16:22:50.006Z (3 months ago)
• Language: TypeScript
• Size: 18.8 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cat Coding — A Webview API Sample

Demonstrates VS Code's [webview API](https://code.visualstudio.com/api/extension-guides/webview). 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.

- Serialization and persistence across VS Code reboots.

## Demo

![demo](demo.gif)

## VS Code API

### `vscode` module

- [`window.createWebviewPanel`](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel)

- [`window.registerWebviewPanelSerializer`](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer)

## Running the example

- Open this example in VS Code 1.25+

- `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.