Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

set alt text of image output items to the corresponding plain/text output #182998

Merged
merged 6 commits into from
May 22, 2023
Merged

set alt text of image output items to the corresponding plain/text output #182998

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dc49b22
set alt text of image output items to the corresponding plain/text ou…
amunger May 19, 2023
caef631
better metadata check
amunger May 19, 2023
7cb0a11
Merge branch 'main' into aamunger/imageAlt
amunger May 19, 2023
2484254
add title for svgs
amunger May 19, 2023
d6db619
prefix metadata altText
amunger May 22, 2023
c7502fe
Merge branch 'main' into aamunger/imageAlt
amunger May 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions extensions/notebook-renderers/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ function renderImage(outputInfo: OutputItem, element: HTMLElement): IDisposable

const image = document.createElement('img');
image.src = src;
const alt = getAltText(outputInfo);
if (alt) {
image.alt = alt;
}
const display = document.createElement('div');
display.classList.add('display');
display.appendChild(image);
Expand Down Expand Up @@ -64,12 +68,33 @@ const domEval = (container: Element) => {
}
};

function getAltText(outputInfo: OutputItem) {
const metadata = outputInfo.metadata;
if (typeof metadata === 'object' && metadata && 'altText' in metadata && typeof metadata.altText === 'string') {
return metadata.altText;
}
return undefined;
}

function injectTitleForSvg(outputInfo: OutputItem, element: HTMLElement) {
if (outputInfo.mime.indexOf('svg') > -1) {
const svgElement = element.querySelector('svg');
const altText = getAltText(outputInfo);
if (svgElement && altText) {
const title = document.createElement('title');
title.innerText = altText;
svgElement.prepend(title);
}
}
}

async function renderHTML(outputInfo: OutputItem, container: HTMLElement, signal: AbortSignal, hooks: Iterable<HtmlRenderingHook>): Promise<void> {
clearContainer(container);
let element: HTMLElement = document.createElement('div');
const htmlContent = outputInfo.text();
const trustedHtml = ttPolicy?.createHTML(htmlContent) ?? htmlContent;
element.innerHTML = trustedHtml as string;
injectTitleForSvg(outputInfo, element);

for (const hook of hooks) {
element = (await hook.postRender(outputInfo, element, signal)) ?? element;
Expand Down
17 changes: 14 additions & 3 deletions src/vs/workbench/contrib/notebook/browser/view/renderers/backLayerWebView.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import { NOTEBOOK_WEBVIEW_BOUNDARY } from 'vs/workbench/contrib/notebook/browser
import { preloadsScriptStr } from 'vs/workbench/contrib/notebook/browser/view/renderers/webviewPreloads';
import { transformWebviewThemeVars } from 'vs/workbench/contrib/notebook/browser/view/renderers/webviewThemeMapping';
import { MarkupCellViewModel } from 'vs/workbench/contrib/notebook/browser/viewModel/markupCellViewModel';
import { CellUri, INotebookRendererInfo, RendererMessagingSpec } from 'vs/workbench/contrib/notebook/common/notebookCommon';
import { CellUri, ICellOutput, INotebookRendererInfo, RendererMessagingSpec } from 'vs/workbench/contrib/notebook/common/notebookCommon';
import { INotebookKernel } from 'vs/workbench/contrib/notebook/common/notebookKernelService';
import { IScopedRendererMessaging } from 'vs/workbench/contrib/notebook/common/notebookRendererMessagingService';
import { INotebookService } from 'vs/workbench/contrib/notebook/common/notebookService';
Expand Down Expand Up @@ -1422,6 +1422,17 @@ export class BackLayerWebView<T extends ICommonCellInfo> extends Themable {
createOutput();
}

private createMetadata(output: ICellOutput, mimeType: string) {
if (mimeType.startsWith('image')) {
const buffer = output.outputs.find(out => out.mime === 'text/plain')?.data.buffer;
if (buffer?.length && buffer?.length > 0) {
const altText = new TextDecoder().decode(buffer);
return { ...output.metadata, altText: altText };
}
}
return output.metadata;
}

private _createOutputCreationMessage(cellInfo: T, content: IInsetRenderOutput, cellTop: number, offset: number, createOnIdle: boolean, initiallyHidden: boolean): { readonly message: ICreationRequestMessage; readonly renderer: INotebookRendererInfo | undefined; transfer: readonly ArrayBuffer[] } {
const messageBase = {
type: 'html',
Expand All @@ -1442,7 +1453,7 @@ export class BackLayerWebView<T extends ICommonCellInfo> extends Themable {
const output = content.source.model;
renderer = content.renderer;
const first = output.outputs.find(op => op.mime === content.mimeType)!;

const metadata = this.createMetadata(output, content.mimeType);
const valueBytes = copyBufferIfNeeded(first.data.buffer, transfer);
message = {
...messageBase,
Expand All @@ -1451,7 +1462,7 @@ export class BackLayerWebView<T extends ICommonCellInfo> extends Themable {
content: {
type: RenderOutputType.Extension,
outputId: output.outputId,
metadata: output.metadata,
metadata: metadata,
output: {
mime: first.mime,
valueBytes,
Expand Down