mirror of
https://github.com/microsoft/vscode.git
synced 2026-07-08 15:55:15 +01:00
improve doc for previewHtml command, also use parse with reviver, fixes #5902
This commit is contained in:
@@ -5,6 +5,7 @@
|
||||
'use strict';
|
||||
|
||||
import URI from 'vs/base/common/uri';
|
||||
import {parse} from 'vs/base/common/marshalling';
|
||||
import {Schemas} from 'vs/base/common/network';
|
||||
import {TPromise} from 'vs/base/common/winjs.base';
|
||||
import {IEditorService} from 'vs/platform/editor/common/editor';
|
||||
@@ -34,7 +35,7 @@ export class OpenerService implements IOpenerService {
|
||||
// execute as command
|
||||
let args: any;
|
||||
try {
|
||||
args = JSON.parse(query);
|
||||
args = parse(query);
|
||||
} catch (e) {
|
||||
//
|
||||
}
|
||||
|
||||
@@ -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' },
|
||||
|
||||
Reference in New Issue
Block a user