fix(painter-dom): honor appearance:hidden on inline SDTs (SD-3110)#3293
Open
caio-pizzol wants to merge 4 commits into
Open
fix(painter-dom): honor appearance:hidden on inline SDTs (SD-3110)#3293caio-pizzol wants to merge 4 commits into
caio-pizzol wants to merge 4 commits into
Conversation
ECMA-376 §17.5.2.6 (w15:appearance val="hidden") means the SDT is
present in the document for anchoring but visually transparent. Two
prior leaks made hidden SDTs anything but:
1. The renderer painted full chrome (padding/border/hover/selected
outline) regardless of appearance, leaving a visible bracket
around the wrapped span.
2. The alias label was stamped into the DOM as a <span> child whose
textContent included the alias. That text leaked into copy-paste
(selecting and copying the wrapped phrase pulled in 'Inline
content' / 'Harvey citation' / whatever the SDT's alias was) AND
into screen-reader output.
The data was already correct end-to-end on the converter side: import
parses w15:appearance into the node attrs (extractAppearance in
handle-structured-content-node.js), and the Document API surfaces it.
The gap was that StructuredContentMetadata in @superdoc/contracts
didn't carry the field, so the pm-adapter -> renderer bridge stripped
it.
Four-file fix:
- contracts: add appearance?: StructuredContentAppearance to
StructuredContentMetadata.
- style-engine: read attrs.appearance in
normalizeStructuredContentMetadata, validating against the three
spec values (boundingBox | tags | hidden); unknown values are
dropped rather than poisoning rendering.
- painter-dom renderer: createInlineSdtWrapper now stamps
data-appearance="hidden" on the wrapper AND skips appending the
alias <span> entirely when hidden.
- painter-dom styles: CSS rule keyed off
[data-appearance='hidden'] zeroes padding/border/border-radius
and neutralizes hover and selected states.
Tests:
- style-engine: appearance carries through, unknown values are
dropped, omitted attr stays undefined.
- painter-dom: render a hidden inline SDT and assert
(a) data-appearance='hidden' is on the wrapper,
(b) no .superdoc-structured-content-inline__label child exists,
(c) wrapper.textContent equals exactly the wrapped phrase with
the alias text nowhere in it.
Verified:
- @superdoc/painter-dom: 1071/1071
- @superdoc/style-engine: 132/132
- @superdoc/contracts: 232/232
- @superdoc/pm-adapter: 1838/1838
superdoc-bot
Bot
added
review: thorough
review: careful
and removed
review: thorough
labels
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 408b268a65
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
End-to-end coverage for the painter-dom fix in #3293. Fixture is a 5-paragraph DOCX with inline SDTs across the appearance matrix: hidden, boundingBox, default (omitted), and two adjacent hidden. Five assertions, one per claim the PR makes plus a copy-paste smoke test: - data-appearance="hidden" stamped on hidden wrappers, absent on others - no __label child inside hidden wrappers; present on others - hidden wrappers omit the alias canary from textContent - no hidden-alias canary appears in the painted layout root - selection.toString() over a hidden wrapper returns only the wrapped phrase Visual coverage follow-up: drop a slim variant in tests/visual/test-data/ via pnpm docs:upload (corpus is R2-backed, not in-tree).
…SD-3110) Caught in review: the lock-hover rule .superdoc-structured-content-inline[data-lock-mode]:hover:not(.ProseMirror-selectednode) has (0,4,0) specificity, one higher than the hidden-appearance rule's (0,3,0). Hovering a hidden inline SDT therefore re-introduced the blue background and z-index 9999999 boost the rule meant to suppress. Exclude data-appearance="hidden" from the inline branch of the lock-hover rule. Block-level branch is untouched; block hidden isn't a render path yet. Adds a behavior regression assertion: hover a hidden wrapper and verify the computed backgroundColor doesn't pick up the lock-hover blue and z-index doesn't jump to 9999999. 18/18 behavior cases × 3 browsers green; painter-dom unit tests still 1071/1071.
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.
Hidden inline content controls (
<w15:appearance w15:val="hidden"/>) were rendering with visible chrome and the alias label was stamped as a child<span>, so the alias text appeared in painter-domtextContentand copy-paste pulled it along with the wrapped phrase.The import side was already correct: the converter parses
w15:appearanceinto node attrs and the Document API surfaces it. The gap was thatStructuredContentMetadatain@superdoc/contractsdidn't carry the field, so the pm-adapter → renderer bridge dropped it. The fix adds it there, threads it throughstyle-engineandpainter-dom, and uses it to (a) stampdata-appearance="hidden"for a CSS rule that strips chrome and (b) skip emitting the alias<span>entirely.Scope is the painted DomPainter surface (what sighted users see and what their selection/copy operates on). The hidden ProseMirror editable still includes the alias as PM text nodes; the screen-reader / keyboard-focus path is a separate concern and is tracked as a follow-up.
Verified:
pnpm --filter @superdoc/painter-dom test→ 1071/1071;style-engine→ 132/132;contracts→ 232/232;pm-adapter→ 1838/1838. New end-to-end coverage intests/behavior/tests/sdt/inline-sdt-appearance.spec.ts(5 cases × 3 browsers, all green) loads a 5-paragraph fixture covering the appearance matrix (hidden / boundingBox / default / two adjacent hidden) and asserts data-attr, missing label child, missing alias in textContent, missing alias anywhere in the painted layout root, and cleanselection.toString().Review: check that no other call site of
createInlineSdtWrapperrelied on the alias label always being present (I confirmed two call sites; both just consume the returned wrapper).