convert to figure/figcaption if caption exists#2056
Open
Ovgodd wants to merge 2 commits into
Open
Conversation
|
@Ovgodd is attempting to deploy a commit to the TypeCell Team on Vercel. A member of the Team first needs to authorize it. |
nperez0111
reviewed
Oct 3, 2025
Comment on lines
+168
to
+172
| const { dom } = createFigureWithCaption(image, block.props.caption); | ||
| // Enhance figure with explicit role and aria-label | ||
| dom.setAttribute("role", "img"); | ||
| dom.setAttribute("aria-label", `Image: ${block.props.caption}`); | ||
| return { dom }; |
Contributor
There was a problem hiding this comment.
Why do this here instead of fixing it in createFigureWithCaption?
Contributor
Author
There was a problem hiding this comment.
I removed it,role="img" isn’t needed on figure since it already has proper semantics for screen readers.
nperez0111
reviewed
Oct 3, 2025
Comment on lines
+149
to
+156
| // Accessibility for exported HTML: prefer caption as alt when present | ||
| if (block.props.caption) { | ||
| image.alt = block.props.caption; | ||
| } else { | ||
| image.alt = ""; | ||
| image.setAttribute("role", "presentation"); | ||
| image.setAttribute("aria-hidden", "true"); | ||
| } |
Contributor
There was a problem hiding this comment.
Missing block.props.name, why not just:
Suggested change
| // Accessibility for exported HTML: prefer caption as alt when present | |
| if (block.props.caption) { | |
| image.alt = block.props.caption; | |
| } else { | |
| image.alt = ""; | |
| image.setAttribute("role", "presentation"); | |
| image.setAttribute("aria-hidden", "true"); | |
| } | |
| image.alt = block.props.name || block.props.caption || ""; | |
| if (!image.alt) { | |
| image.setAttribute("role", "presentation"); | |
| image.setAttribute("aria-hidden", "true"); | |
| } |
nperez0111
reviewed
Oct 3, 2025
Comment on lines
+73
to
+88
| // Accessibility: set alt/aria based on presence of caption per RGAA | ||
| const accessibleImageWithCaption = () => { | ||
| image.alt = block.props.caption; | ||
| image.removeAttribute("aria-hidden"); | ||
| image.removeAttribute("role"); | ||
| image.setAttribute("tabindex", "0"); | ||
| }; | ||
|
|
||
| const accessibleImage = () => { | ||
| image.alt = ""; | ||
| image.setAttribute("role", "presentation"); | ||
| image.setAttribute("aria-hidden", "true"); | ||
| image.setAttribute("tabindex", "-1"); | ||
| }; | ||
|
|
||
| block.props.caption ? accessibleImageWithCaption() : accessibleImage(); |
Contributor
There was a problem hiding this comment.
Same as below, just fallback when there is no alt, and this doesn't have the block.props.name
nperez0111
reviewed
Oct 3, 2025
Comment on lines
+55
to
+79
| // Special accessible structure for images with captions: use figure/figcaption | ||
| const shouldUseFigure = | ||
| element && | ||
| block.type === "image" && | ||
| block.props.caption && | ||
| block.props.showPreview !== false; | ||
| if (shouldUseFigure) { | ||
| const figure = document.createElement("figure"); | ||
| figure.className = wrapper.className; | ||
|
|
||
| // Move preview element inside the figure | ||
| figure.appendChild(element.dom); | ||
|
|
||
| // Create figcaption instead of a paragraph | ||
| const figcaption = document.createElement("figcaption"); | ||
| figcaption.className = "bn-file-caption"; | ||
| figcaption.textContent = block.props.caption; | ||
| figure.appendChild(figcaption); | ||
|
|
||
| // ARIA enhancements for screen readers | ||
| figure.setAttribute("role", "img"); | ||
| figure.setAttribute("aria-label", `Image: ${block.props.caption}`); | ||
|
|
||
| return { dom: figure, destroy: element.destroy }; | ||
| } |
Contributor
There was a problem hiding this comment.
I would prefer this as attributes rather than figure figcaption, this makes the code more difficult to reason about, and don't buy that it is any more accessible
nperez0111
added a commit
that referenced
this pull request
May 7, 2026
Closes #2055. Supersedes #2056. When a file/image/video/audio block has a caption, render the wrapper as <figure> with a <figcaption> instead of a <div>+<p>. This matches the WCAG-recommended semantic for caption-content association and removes the need for ad-hoc ARIA fallbacks. Image alt text logic is also tightened: - caption present -> alt="" (the figcaption is the accessible name; this avoids screen readers double-announcing the caption) - no caption, name present -> alt={name} - neither -> alt="" (decorative; aria-hidden was dropped because it would have removed unintentionally-unlabeled images from the accessibility tree entirely) Co-Authored-By: Cyril G <c.gromoff@gmail.com> Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Improve accessibility and semantic HTML by applying the appropriate structure when captions are present, to comply with WCAG requirement.
issue : 2055
Proposal
figcaptiontagfiguretagfigcaptiontag