Skip to content

docs(ui): note content controls in entityAt hit types (SD-3313) #3573

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

Merged
caio-pizzol merged 1 commit into from
May 29, 2026
Merged

docs(ui): note content controls in entityAt hit types (SD-3313) #3573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 6 deletions packages/super-editor/src/ui/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1907,7 +1907,7 @@ export interface ViewportHandle {
* Look up entities painted under a viewport coordinate. Used by
* right-click menus and hover tooltips to ask "what's at this point?"
* without consumers reading `data-track-change-id` /
* `data-comment-ids` off the painted DOM themselves; the
* `data-comment-ids` / `data-sdt-id` off the painted DOM themselves; the
* data-attribute layout is an implementation detail of the painter
* that consumers shouldn't depend on.
*
Expand All @@ -1924,11 +1924,12 @@ export interface ViewportHandle {
* ids from the other's DOM, and post-destroy calls return `[]`
* rather than stale ids from cached painted nodes.
*
* Today the supported entity types are `comment` and `trackedChange`.
* `link`, `image`, and `tableCell` are reserved for follow-ups;
* adding them is purely additive (new union members), so callers can
* `switch` on `hit.type` and the default branch remains forward
* compatible.
* Today the supported entity types are `comment`, `trackedChange`, and
* `contentControl` (content controls / SDT fields, whose hit also carries
* `scope` and `tag`). `link`, `image`, and `tableCell` are reserved for
* follow-ups; adding them is purely additive (new union members), so
* callers can `switch` on `hit.type` and the default branch remains
* forward compatible.
*/
entityAt(input: ViewportEntityAtInput): ViewportEntityHit[];
/**
Expand Down
Loading