WebviewPanelSerializer<T> class
Restore webview panels that have been persisted when vscode shuts down.
There are two types of webview persistence:
- Persistence within a session.
- Persistence across sessions (across restarts of the editor).
A WebviewPanelSerializer is only required for the second case: persisting a webview across sessions.
Persistence within a session allows a webview to save its state when it becomes hidden
and restore its content from this state when it becomes visible again. It is powered entirely
by the webview content itself. To save off a persisted state, call acquireVsCodeApi().setState() with
any json serializable object. To restore the state again, call getState()
// Within the webview
const vscode = acquireVsCodeApi();
// Get existing state
const oldState = vscode.getState() || { value: 0 };
// Update state
setState({ value: oldState.value + 1 })
A WebviewPanelSerializer extends this persistence across restarts of the editor. When the editor is shutdown,
it will save off the state from setState of all webviews that have a serializer. When the
webview first becomes visible after the restart, this state is passed to deserializeWebviewPanel.
The extension can then restore the old WebviewPanel from this state.
- Available extensions
- Annotations
-
- @JS()
- @staticInterop
- @anonymous
Constructors
- WebviewPanelSerializer({Future deserializeWebviewPanel(WebviewPanel, Object?)?})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited