bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
d4e46c9fb4da9420b16ca2f800cb7c3e495c303a
vscode-extension-samples/uri-handler-sample
History
Connor Peet f4e09a3b7b chore: update dependencies (#996) 
- Update @vscode/test-electron due to some bugs
- Update @vscode/test-cli for modern goodness
- vscode-dts -> @vscode/dts off of the deprecated name
- @types/node to 18 to match VS Code itself
2024-04-02 01:29:31 +02:00
..
.vscode
Add URI handler sample (#405)
2021-05-11 16:32:09 -07:00
src
Make sure all samples are extending the eslint base configs
2022-12-06 15:03:41 -08:00
.eslintrc.json
Make sure all samples are extending the eslint base configs
2022-12-06 15:03:41 -08:00
package-lock.json
chore: update dependencies (#996)
2024-04-02 01:29:31 +02:00
package.json
chore: update dependencies (#996)
2024-04-02 01:29:31 +02:00
README.md
Add URI handler sample (#405)
2021-05-11 16:32:09 -07:00
tsconfig.json
Bump all targets to es2020
2022-02-28 13:45:21 -08:00

README.md

Uri Handlers

This sample demonstrates how to implement a Uri handler in VS Code. A Uri handler is run when a browser redirects to VS Code with a specific extension id as the authority.

Examples:

  • vscode://vscode-samples.uri-handler-sample
  • vscode-insiders://vscode-samples.uri-handler-sample

If you paste these Uris into your browser, they will open VS Code and VS Code insiders, respectively.

This sample provides a simple Uri handler that shows an information message when a Uri is handled. Additionally, if a query string was included in the Uri, it will include that in the message.

Run the sample and try opening the following Uris in your browser:

  • vscode://vscode-samples.uri-handler-sample
  • vscode://vscode-samples.uri-handler-sample?q=hello

Note: use vscode-insiders:// if you ran the sample in insiders.

VS Code API

This sample uses following APIs

APIs

  • window.registerUriHandler
  • env.uriScheme
  • env.asExternalUri
  • UriHandler

Be sure to look at the API Docs for usage.

Running the Sample

  • Open this example in VS Code Insiders
  • npm install
  • npm run watch
  • F5 to start debugging
  • Run the Start handling Uris command