Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-25 11:08:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve doc for previewHtml command, also use parse with reviver, fixes #5902

Browse Source
This commit is contained in:
Johannes Rieken
2016-04-28 10:55:39 +02:00
parent 50807c9ea0
commit 1c08e3ffea
2 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/vs/workbench/api/node/extHostApiCommands.ts
View File

@@ -159,8 +159,15 @@ class ExtHostApiCommands {
description: `
Render the html of the resource in an editor view.
Links contained in the document will be handled by VS Code whereby it supports file-resources and virtual resources
as well as triggering commands using the 'command'-scheme.
Links contained in the document will be handled by VS Code whereby it supports \`file\`-resources and
[virtual](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.d.ts#L3295)-resources
as well as triggering commands using the \`command\`-scheme. Use the query part of a command-uri to pass along JSON-encoded
arguments - note that URL-encoding must be applied. The snippet below defines a command-link that calls the _previewHtml_
command and passes along an uri:
\`\`\`
let href = encodeURI('command:vscode.previewHtml?' + JSON.stringify(someUri));
let html = '<a href="' + href + '">Show Resource...</a>.';
\`\`\`
`,
args: [
{ name: 'uri', description: 'Uri of the resource to preview.', constraint: value => value instanceof URI || typeof value === 'string' },