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.

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

[Editor] Use the alt text to descibe the canvas used to display the image #17058

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions src/display/editor/editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,9 @@ class AnnotationEditor {
if (!tooltip.parentNode) {
button.append(tooltip);
}

const element = this.getImageForAltText();
element?.setAttribute("aria-describedby", tooltip.id);
}

#toggleAltTextButton(enabled = false) {
Expand Down Expand Up @@ -960,6 +963,9 @@ class AnnotationEditor {
};
}

/**
* Set the alt text data.
*/
set altTextData({ altText, decorative }) {
if (this.#altText === altText && this.#altTextDecorative === decorative) {
return;
Expand Down Expand Up @@ -1369,6 +1375,13 @@ class AnnotationEditor {
*/
enterInEditMode() {}

/**
* @returns {HTMLElement | null} the element requiring an alt text.
*/
getImageForAltText() {
return null;
}

/**
* Get the div which really contains the displayed content.
* @returns {HTMLDivElement | undefined}
Expand Down
13 changes: 13 additions & 0 deletions src/display/editor/stamp.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ class StampEditor extends AnnotationEditor {

#bitmapFile = null;

#bitmapFileName = "";

#canvas = null;

#observer = null;
Expand Down Expand Up @@ -104,6 +106,9 @@ class StampEditor extends AnnotationEditor {
this.#bitmapId = data.id;
this.#isSvg = data.isSvg;
}
if (data.file) {
this.#bitmapFileName = data.file.name;
}
this.#createCanvas();
}

Expand Down Expand Up @@ -332,6 +337,9 @@ class StampEditor extends AnnotationEditor {
},
});
this.addAltTextButton();
if (this.#bitmapFileName) {
canvas.setAttribute("aria-label", this.#bitmapFileName);
}
}

/**
Expand Down Expand Up @@ -438,6 +446,11 @@ class StampEditor extends AnnotationEditor {
);
}

/** @inheritdoc */
getImageForAltText() {
return this.#canvas;
}

#serializeBitmap(toUrl) {
if (toUrl) {
if (this.#isSvg) {
Expand Down
36 changes: 33 additions & 3 deletions test/integration/stamp_editor_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -249,9 +249,34 @@ describe("Stamp Editor", () => {
]);
}, data);

await page.keyboard.down("Control");
await page.keyboard.press("v");
await page.keyboard.up("Control");
let hasPasteEvent = false;
while (!hasPasteEvent) {
// We retry to paste if nothing has been pasted before 500ms.
const promise = Promise.race([
page.evaluate(
() =>
new Promise(resolve => {
document.addEventListener(
"paste",
e => resolve(e.clipboardData.items.length !== 0),
{
once: true,
}
);
})
),
page.evaluate(
() =>
new Promise(resolve => {
setTimeout(() => resolve(false), 500);
})
),
]);
await page.keyboard.down("Control");
await page.keyboard.press("v");
await page.keyboard.up("Control");
hasPasteEvent = await promise;
}

await waitForImage(page, getEditorSelector(0));

Expand All @@ -277,6 +302,11 @@ describe("Stamp Editor", () => {
const saveButtonSelector = "#altTextDialog #altTextSave";
await page.click(saveButtonSelector);

// Check that the canvas has an aria-describedby attribute.
await page.waitForSelector(
`${getEditorSelector(0)} canvas[aria-describedby]`
);

// Wait for the alt-text button to have the correct icon.
await page.waitForSelector(`${buttonSelector}:not([hidden]).done`);

Expand Down