Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to VS Code's webview API #931

Closed
mjbvz opened this issue Nov 6, 2018 · 3 comments
Closed

Upgrade to VS Code's webview API #931

mjbvz opened this issue Nov 6, 2018 · 3 comments
Labels

Comments

@mjbvz
Copy link

mjbvz commented Nov 6, 2018

Hi, I'm on the VS Code team. I noticed that your extension uses the vscode.previewHtml command which is deprecated and which we are actively working to remove: microsoft/vscode#62630

We've developed a webview API that provides a much better developer experience and offers a number of important security and compatibility benefits over previewHtml. We cannot fix previewHtml without breaking backwards compatibility, and have instead opted to remove it.

To ensure that your extension continues to work properly in VS Code, please try upgrading to use the new Webview API. You can find documentation on the API usage here. Let me know if you have any questions or concerns about this migration

@StephenWeatherford
Copy link
Contributor

@mjbvz Matt, do you have a timeline for removing previewHtml? Also, any guesses on cost to change over? Thx.

@mjbvz
Copy link
Author

mjbvz commented Nov 7, 2018

Aggressively target March / April for removal. Cost of change depends on how complex your use of html preview is and how tied your extension is to the old behavior. In most cases, the webview api simplifies the code compared to previewHtml

@PrashanthCorp PrashanthCorp added this to the 0.11.0 milestone Nov 7, 2018
@mjbvz
Copy link
Author

mjbvz commented Feb 1, 2019

Just a heads up: in VS Code 1.32 (the February update), using the previewHtml command will show an alert to the user, although the command should still work. We plan to remove the command entirely with VS Code 1.33 (March update)

@vscodebot vscodebot bot locked and limited conversation to collaborators May 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants