From ad6f4faafb32d4e973a21da201da2850afffa9de Mon Sep 17 00:00:00 2001 From: Johannes Rieken Date: Wed, 18 Nov 2020 16:25:48 +0100 Subject: [PATCH] use better name for async markdown rendering, https://github.com/microsoft/vscode/issues/67806 --- src/vs/base/browser/markdownRenderer.ts | 10 +++++----- src/vs/editor/browser/core/markdownRenderer.ts | 8 ++++---- src/vs/editor/contrib/hover/modesContentHover.ts | 2 +- src/vs/editor/contrib/suggest/suggestWidgetDetails.ts | 2 +- .../notebook/browser/view/renderers/markdownCell.ts | 2 +- src/vs/workbench/services/hover/browser/hoverWidget.ts | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/vs/base/browser/markdownRenderer.ts b/src/vs/base/browser/markdownRenderer.ts index a7468e322b5..a5cd4c5ec84 100644 --- a/src/vs/base/browser/markdownRenderer.ts +++ b/src/vs/base/browser/markdownRenderer.ts @@ -28,7 +28,7 @@ export interface MarkedOptions extends marked.MarkedOptions { export interface MarkdownRenderOptions extends FormattedTextRenderOptions { codeBlockRenderer?: (modeId: string, value: string) => Promise; - codeBlockRenderCallback?: () => void; + asyncRenderCallback?: () => void; baseUrl?: URI; } @@ -177,8 +177,8 @@ export function renderMarkdown(markdown: IMarkdownString, options: MarkdownRende // ignore }); - if (options.codeBlockRenderCallback) { - promise.then(options.codeBlockRenderCallback); + if (options.asyncRenderCallback) { + promise.then(options.asyncRenderCallback); } return `
${escape(code)}
`; @@ -245,11 +245,11 @@ export function renderMarkdown(markdown: IMarkdownString, options: MarkdownRende signalInnerHTML!(); // signal size changes for image tags - if (options.codeBlockRenderCallback) { + if (options.asyncRenderCallback) { for (const img of element.getElementsByTagName('img')) { const listener = DOM.addDisposableListener(img, 'load', () => { listener.dispose(); - options.codeBlockRenderCallback!(); + options.asyncRenderCallback!(); }); } } diff --git a/src/vs/editor/browser/core/markdownRenderer.ts b/src/vs/editor/browser/core/markdownRenderer.ts index 375518d2ce0..e1eb76c8a87 100644 --- a/src/vs/editor/browser/core/markdownRenderer.ts +++ b/src/vs/editor/browser/core/markdownRenderer.ts @@ -38,8 +38,8 @@ export class MarkdownRenderer { } }); - private readonly _onDidRenderCodeBlock = new Emitter(); - readonly onDidRenderCodeBlock = this._onDidRenderCodeBlock.event; + private readonly _onDidRenderAsync = new Emitter(); + readonly onDidRenderAsync = this._onDidRenderAsync.event; constructor( private readonly _options: IMarkdownRendererOptions, @@ -48,7 +48,7 @@ export class MarkdownRenderer { ) { } dispose(): void { - this._onDidRenderCodeBlock.dispose(); + this._onDidRenderAsync.dispose(); } render(markdown: IMarkdownString | undefined, options?: MarkdownRenderOptions, markedOptions?: MarkedOptions): IMarkdownRenderResult { @@ -103,7 +103,7 @@ export class MarkdownRenderer { return element; }, - codeBlockRenderCallback: () => this._onDidRenderCodeBlock.fire(), + asyncRenderCallback: () => this._onDidRenderAsync.fire(), actionHandler: { callback: (content) => this._openerService.open(content, { fromUserGesture: true }).catch(onUnexpectedError), disposeables diff --git a/src/vs/editor/contrib/hover/modesContentHover.ts b/src/vs/editor/contrib/hover/modesContentHover.ts index 005e098534f..8b1f88e7b39 100644 --- a/src/vs/editor/contrib/hover/modesContentHover.ts +++ b/src/vs/editor/contrib/hover/modesContentHover.ts @@ -480,7 +480,7 @@ export class ModesContentHoverWidget extends ContentHoverWidget { const markdownHoverElement = $('div.hover-row.markdown-hover'); const hoverContentsElement = dom.append(markdownHoverElement, $('div.hover-contents')); const renderer = markdownDisposeables.add(new MarkdownRenderer({ editor: this._editor }, this._modeService, this._openerService)); - markdownDisposeables.add(renderer.onDidRenderCodeBlock(() => { + markdownDisposeables.add(renderer.onDidRenderAsync(() => { hoverContentsElement.className = 'hover-contents code-hover-contents'; this._hover.onContentsChanged(); })); diff --git a/src/vs/editor/contrib/suggest/suggestWidgetDetails.ts b/src/vs/editor/contrib/suggest/suggestWidgetDetails.ts index 08b9c064ed1..5d0b4b8930d 100644 --- a/src/vs/editor/contrib/suggest/suggestWidgetDetails.ts +++ b/src/vs/editor/contrib/suggest/suggestWidgetDetails.ts @@ -170,7 +170,7 @@ export class SuggestDetailsWidget { const renderedContents = this._markdownRenderer.render(documentation); this._docs.appendChild(renderedContents.element); this._renderDisposeable.add(renderedContents); - this._renderDisposeable.add(this._markdownRenderer.onDidRenderCodeBlock(() => { + this._renderDisposeable.add(this._markdownRenderer.onDidRenderAsync(() => { this.layout(this._size.width, this._type.clientHeight + this._docs.clientHeight); this._onDidChangeContents.fire(this); })); diff --git a/src/vs/workbench/contrib/notebook/browser/view/renderers/markdownCell.ts b/src/vs/workbench/contrib/notebook/browser/view/renderers/markdownCell.ts index f75ca70eee4..156b44c8a78 100644 --- a/src/vs/workbench/contrib/notebook/browser/view/renderers/markdownCell.ts +++ b/src/vs/workbench/contrib/notebook/browser/view/renderers/markdownCell.ts @@ -255,7 +255,7 @@ export class StatefulMarkdownCell extends Disposable { this.relayoutCell(); } else { // first time, readonly mode - this.localDisposables.add(markdownRenderer.onDidRenderCodeBlock(() => { + this.localDisposables.add(markdownRenderer.onDidRenderAsync(() => { this.viewCell.renderedMarkdownHeight = this.templateData.container.clientHeight; this.relayoutCell(); })); diff --git a/src/vs/workbench/services/hover/browser/hoverWidget.ts b/src/vs/workbench/services/hover/browser/hoverWidget.ts index 6a532803e66..10a98c4375e 100644 --- a/src/vs/workbench/services/hover/browser/hoverWidget.ts +++ b/src/vs/workbench/services/hover/browser/hoverWidget.ts @@ -94,7 +94,7 @@ export class HoverWidget extends Widget { callback: (content) => this._linkHandler(content), disposeables: this._messageListeners }, - codeBlockRenderCallback: () => { + asyncRenderCallback: () => { contentsElement.classList.add('code-hover-contents'); // This changes the dimensions of the hover so trigger a layout this._onRequestLayout.fire();