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
153c4f2e056761eafb196aac6dce4ac54f382f39
vscode-extension-samples/uri-handler-sample
History
dependabot[bot] 153c4f2e05 Bump ansi-regex from 3.0.0 to 3.0.1 in /uri-handler-sample 
Bumps [ansi-regex](https://github.com/chalk/ansi-regex) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/chalk/ansi-regex/releases)
- [Commits](https://github.com/chalk/ansi-regex/compare/v3.0.0...v3.0.1)

---
updated-dependencies:
- dependency-name: ansi-regex
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-01 18:32:51 +00:00
..
.vscode
Add URI handler sample (#405)
2021-05-11 16:32:09 -07:00
src
Add URI handler sample (#405)
2021-05-11 16:32:09 -07:00
.eslintrc.json
Add URI handler sample (#405)
2021-05-11 16:32:09 -07:00
package-lock.json
Bump ansi-regex from 3.0.0 to 3.0.1 in /uri-handler-sample
2022-04-01 18:32:51 +00:00
package.json
Update samples to build with TS 4.5.5
2022-02-09 11:38:40 -08: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