-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: chang getState and setState methods
- Loading branch information
Showing
12 changed files
with
72 additions
and
312 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,2 @@ | ||
| import type { WebviewApi } from 'vscode-webview'; | ||
|
|
||
| /** | ||
| * A utility wrapper around the acquireVsCodeApi() function, which enables | ||
| * message passing and state management between the webview and extension | ||
| * contexts. | ||
| * | ||
| * This utility also enables webview code to be run in a web browser-based | ||
| * dev server by using native web browser features that mock the functionality | ||
| * enabled by acquireVsCodeApi. | ||
| */ | ||
| class VSCodeAPIWrapper { | ||
| private readonly vsCodeApi: WebviewApi<unknown> | undefined; | ||
|
|
||
| constructor() { | ||
| console.log(typeof acquireVsCodeApi); | ||
| // Check if the acquireVsCodeApi function exists in the current development | ||
| // context (i.e. VS Code development window or web browser) | ||
| if (typeof acquireVsCodeApi === 'function') { | ||
| this.vsCodeApi = acquireVsCodeApi(); | ||
| } | ||
| } | ||
|
|
||
| // private init() { | ||
| // // TODO 环境变量判断 | ||
| // } | ||
|
|
||
| /** | ||
| * Post a message (i.e. send arbitrary data) to the owner of the webview. | ||
| * | ||
| * @remarks When running webview code inside a web browser, postMessage will instead | ||
| * log the given message to the console. | ||
| * | ||
| * @param message Abitrary data (must be JSON serializable) to send to the extension context. | ||
| */ | ||
| public postMessage(message: unknown) { | ||
| if (this.vsCodeApi) { | ||
| this.vsCodeApi.postMessage(message); | ||
| } else { | ||
| window.parent.postMessage({ type: 'page:message', data: message }, '*'); | ||
| console.log(message); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the persistent state stored for this webview. | ||
| * | ||
| * @remarks When running webview source code inside a web browser, getState will retrieve state | ||
| * from local storage (https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). | ||
| * | ||
| * @return The current state or `undefined` if no state has been set. | ||
| */ | ||
| public getState(): unknown | undefined { | ||
| if (this.vsCodeApi) { | ||
| return this.vsCodeApi.getState(); | ||
| } else { | ||
| const state = localStorage.getItem('vscodeState'); | ||
| return state ? JSON.parse(state) : undefined; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Set the persistent state stored for this webview. | ||
| * | ||
| * @remarks When running webview source code inside a web browser, setState will set the given | ||
| * state using local storage (https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). | ||
| * | ||
| * @param newState New persisted state. This must be a JSON serializable object. Can be retrieved | ||
| * using {@link getState}. | ||
| * | ||
| * @return The new state. | ||
| */ | ||
| public setState<T extends unknown | undefined>(newState: T): T { | ||
| if (this.vsCodeApi) { | ||
| return this.vsCodeApi.setState(newState); | ||
| } else { | ||
| localStorage.setItem('vscodeState', JSON.stringify(newState)); | ||
| return newState; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Exports class singleton to prevent multiple invocations of acquireVsCodeApi. | ||
| export const vscode = new VSCodeAPIWrapper(); | ||
| export const vscode = acquireVsCodeApi<any>(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,2 @@ | ||
| import type { WebviewApi } from 'vscode-webview'; | ||
|
|
||
| /** | ||
| * A utility wrapper around the acquireVsCodeApi() function, which enables | ||
| * message passing and state management between the webview and extension | ||
| * contexts. | ||
| * | ||
| * This utility also enables webview code to be run in a web browser-based | ||
| * dev server by using native web browser features that mock the functionality | ||
| * enabled by acquireVsCodeApi. | ||
| */ | ||
| class VSCodeAPIWrapper { | ||
| private readonly vsCodeApi: WebviewApi<unknown> | undefined; | ||
|
|
||
| constructor() { | ||
| console.log(typeof acquireVsCodeApi); | ||
| // Check if the acquireVsCodeApi function exists in the current development | ||
| // context (i.e. VS Code development window or web browser) | ||
| if (typeof acquireVsCodeApi === 'function') { | ||
| this.vsCodeApi = acquireVsCodeApi(); | ||
| } | ||
| } | ||
|
|
||
| // private init() { | ||
| // // TODO 环境变量判断 | ||
| // } | ||
|
|
||
| /** | ||
| * Post a message (i.e. send arbitrary data) to the owner of the webview. | ||
| * | ||
| * @remarks When running webview code inside a web browser, postMessage will instead | ||
| * log the given message to the console. | ||
| * | ||
| * @param message Abitrary data (must be JSON serializable) to send to the extension context. | ||
| */ | ||
| public postMessage(message: unknown) { | ||
| if (this.vsCodeApi) { | ||
| this.vsCodeApi.postMessage(message); | ||
| } else { | ||
| window.parent.postMessage({ type: 'page:message', data: message }, '*'); | ||
| console.log(message); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the persistent state stored for this webview. | ||
| * | ||
| * @remarks When running webview source code inside a web browser, getState will retrieve state | ||
| * from local storage (https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). | ||
| * | ||
| * @return The current state or `undefined` if no state has been set. | ||
| */ | ||
| public getState(): unknown | undefined { | ||
| if (this.vsCodeApi) { | ||
| return this.vsCodeApi.getState(); | ||
| } else { | ||
| const state = localStorage.getItem('vscodeState'); | ||
| return state ? JSON.parse(state) : undefined; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Set the persistent state stored for this webview. | ||
| * | ||
| * @remarks When running webview source code inside a web browser, setState will set the given | ||
| * state using local storage (https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). | ||
| * | ||
| * @param newState New persisted state. This must be a JSON serializable object. Can be retrieved | ||
| * using {@link getState}. | ||
| * | ||
| * @return The new state. | ||
| */ | ||
| public setState<T extends unknown | undefined>(newState: T): T { | ||
| if (this.vsCodeApi) { | ||
| return this.vsCodeApi.setState(newState); | ||
| } else { | ||
| localStorage.setItem('vscodeState', JSON.stringify(newState)); | ||
| return newState; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Exports class singleton to prevent multiple invocations of acquireVsCodeApi. | ||
| export const vscode = new VSCodeAPIWrapper(); | ||
| export const vscode = acquireVsCodeApi<any>(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.