development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-27 21:09:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename webviewOptions.keepAlive to retainContextWhenHidden to make it more clear what this option does

Browse source
This commit is contained in:
Matt Bierner 2018-02-26 15:28:41 -08:00
parent 9b69b61eaf
commit 978beebd0a
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/vs/vscode.proposed.d.ts vendored
View file

@ -484,19 +484,19 @@ declare module 'vscode' {
readonly enableCommandUris?: boolean;
/**
* Should the webview content be kept arount even when the webview is no longer visible?
* Should the webview's context be kept around even when the webview is no longer visible?
*
* Normally a webview content is created when the webview becomes visible
* Normally a webview's context is created when the webview becomes visible
* and destroyed when the webview is hidden. Apps that have complex state
* or UI can set the `keepAlive` property to make VS Code keep the webview
* content around, even when the webview itself is no longer visible. When
* the webview becomes visible again, the content is automatically restored
* in the exact same state it was in originally
* or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
* context around, even when the webview moves to a background tab. When
* the webview becomes visible again, the context is automatically restored
* in the exact same state it was in originally.
*
* `keepAlive` has a high memory overhead and should only be used if your
* webview content cannot be quickly saved and restored.
* `retainContextWhenHidden` has a high memory overhead and should only be used if
* your webview content cannot be quickly saved and restored.
*/
readonly keepAlive?: boolean;
readonly retainContextWhenHidden?: boolean;
/**
* Root paths from which the webview can load local (filesystem) resources using the `vscode-workspace-resource:` scheme.

2
src/vs/workbench/api/electron-browser/mainThreadWebview.ts
View file

@ -186,7 +186,7 @@ class WebviewInput extends EditorInput {
public releaseWebview(owner: any) {
if (this._webviewOwner === owner) {
this._webviewOwner = undefined;
if (!this._options.keepAlive) {
if (!this._options.retainContextWhenHidden) {
this.disposeWebview();
}
}