Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-20 16:49:06 +01:00
Code Issues Packages Projects Releases Wiki Activity

Split out Webview from WebviewEditor in proposed API (#47370)

Browse Source 
* Split out `Webview` from `WebviewEditor` in API

**Problem**
The current proposed `Webview` interface has a few methods and properties that are very editor specific, such as `.reveal` and `.onDidChangeViewState`. These properies will not make sense if we ever allow webview to be displayed in other locations, such as in widgets

**Proposal**
Split the concepts of a `Webview` and of a `WebveiwEditor`. A webview is the html content itself. A `WebviewEditor` is an editor that displays a `Webview`

This would allow us to easily add other types of `Webview` owning objects in the future without having to document that some methods only apply when a webview is used as an editor vs as a widget
This commit is contained in:
Matt Bierner
2018-04-11 11:49:02 -07:00
committed by GitHub
parent 485a469b94
commit 8cb7e80544
9 changed files with 230 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
extensions/markdown-language-features/src/features/preview.ts
View File

@@ -20,7 +20,7 @@ export class MarkdownPreview {
public static viewType = 'markdown.preview';
private readonly webview: vscode.Webview;
private readonly editor: vscode.WebviewEditor;
private throttleTimer: any;
private line: number | undefined = undefined;
private readonly disposables: vscode.Disposable[] = [];
@@ -32,7 +32,7 @@ export class MarkdownPreview {
public static async revive(
webview: vscode.Webview,
webview: vscode.WebviewEditor,
state: any,
contentProvider: MarkdownContentProvider,
previewConfigurations: MarkdownPreviewConfigurationManager,
@@ -69,7 +69,7 @@ export class MarkdownPreview {
topmostLineMonitor: MarkdownFileTopmostLineMonitor,
contributions: MarkdownContributions
): MarkdownPreview {
const webview = vscode.window.createWebview(
const webview = vscode.window.createWebviewEditor(
MarkdownPreview.viewType,
MarkdownPreview.getPreviewTitle(resource, locked),
previewColumn, {
@@ -90,7 +90,7 @@ export class MarkdownPreview {
}
private constructor(
webview: vscode.Webview,
webview: vscode.WebviewEditor,
private _resource: vscode.Uri,
public locked: boolean,
private readonly contentProvider: MarkdownContentProvider,
@@ -98,17 +98,17 @@ export class MarkdownPreview {
private readonly logger: Logger,
topmostLineMonitor: MarkdownFileTopmostLineMonitor
) {
this.webview = webview;
this.editor = webview;
this.webview.onDidDispose(() => {
this.editor.onDidDispose(() => {
this.dispose();
}, null, this.disposables);
this.webview.onDidChangeViewState(e => {
this.editor.onDidChangeViewState(e => {
this._onDidChangeViewStateEmitter.fire(e);
}, null, this.disposables);
this.webview.onDidReceiveMessage(e => {
this.editor.webview.onDidReceiveMessage(e => {
if (e.source !== this._resource.toString()) {
return;
}
@@ -155,7 +155,7 @@ export class MarkdownPreview {
private readonly _onDisposeEmitter = new vscode.EventEmitter<void>();
public readonly onDispose = this._onDisposeEmitter.event;
private readonly _onDidChangeViewStateEmitter = new vscode.EventEmitter<vscode.WebviewOnDidChangeViewStateEvent>();
private readonly _onDidChangeViewStateEmitter = new vscode.EventEmitter<vscode.WebviewEditorOnDidChangeViewStateEvent>();
public readonly onDidChangeViewState = this._onDidChangeViewStateEmitter.event;
public get resource(): vscode.Uri {
@@ -180,7 +180,7 @@ export class MarkdownPreview {
this._onDisposeEmitter.dispose();
this._onDidChangeViewStateEmitter.dispose();
this.webview.dispose();
this.editor.dispose();
disposeAll(this.disposables);
}
@@ -224,15 +224,15 @@ export class MarkdownPreview {
}
public get viewColumn(): vscode.ViewColumn | undefined {
return this.webview.viewColumn;
return this.editor.viewColumn;
}
public isPreviewOf(resource: vscode.Uri): boolean {
return this._resource.fsPath === resource.fsPath;
}
public isWebviewOf(webview: vscode.Webview): boolean {
return this.webview === webview;
public isWebviewOf(webview: vscode.WebviewEditor): boolean {
return this.editor === webview;
}
public matchesResource(
@@ -256,12 +256,12 @@ export class MarkdownPreview {
}
public reveal(viewColumn: vscode.ViewColumn) {
this.webview.reveal(viewColumn);
this.editor.reveal(viewColumn);
}
public toggleLock() {
this.locked = !this.locked;
this.webview.title = MarkdownPreview.getPreviewTitle(this._resource, this.locked);
this.editor.webview.title = MarkdownPreview.getPreviewTitle(this._resource, this.locked);
}
private static getPreviewTitle(resource: vscode.Uri, locked: boolean): string {
@@ -293,7 +293,7 @@ export class MarkdownPreview {
private postMessage(msg: any) {
if (!this._disposed) {
this.webview.postMessage(msg);
this.editor.webview.postMessage(msg);
}
}
@@ -315,8 +315,8 @@ export class MarkdownPreview {
this.currentVersion = { resource, version: document.version };
const content = await this.contentProvider.provideTextDocumentContent(document, this.previewConfigurations, this.line);
if (this._resource === resource) {
this.webview.title = MarkdownPreview.getPreviewTitle(this._resource, this.locked);
this.webview.html = content;
this.editor.webview.title = MarkdownPreview.getPreviewTitle(this._resource, this.locked);
this.editor.webview.html = content;
}
}