Skip to content

refactor(ui): drop ui.review, add ui.trackChanges (SD-2667)#3030

Merged
caio-pizzol merged 1 commit intostablefrom
caio/sd-2667-ui-track-changes-rename-stable
Apr 30, 2026
Merged

refactor(ui): drop ui.review, add ui.trackChanges (SD-2667)#3030
caio-pizzol merged 1 commit intostablefrom
caio/sd-2667-ui-track-changes-rename-stable

Conversation

@caio-pizzol
Copy link
Copy Markdown
Contributor

Cherry-pick of #3029 onto stable so the public superdoc/ui surface stays aligned across release channels. ui.review was just shipping; releasing stable with that name while main calls it ui.trackChanges would split the type names across consumers tracking each branch.

Picks the rename only. Conflicts resolved by keeping stable's existing surface where it diverges from main (no ui.document handle on stable yet, no behavior/block options on presentation.navigateTo here, no BYO-UI demo on stable). The behavioral change is identical to #3029: ui.review removed, ui.trackChanges added with accept / reject / acceptAll / rejectAll / next / previous / scrollTo, useSuperDocReview becomes useSuperDocTrackChanges.

Verified: 136/136 super-editor UI tests pass on this branch; superdoc build clean.

Related: #3029 (merged into main).

`ui.review` shipped a merged comments + tracked-changes feed with
`accept` / `reject` verbs, but the merged-feed concept was speculative.
No customer asked for it, and consumers building review sidebars can
compose `ui.comments.items` and `ui.trackChanges.items` themselves
(roughly 30 LOC, demonstrated in the BYO-UI demo's ActivitySidebar).
Mirroring `editor.doc.trackChanges` keeps the controller surface tight
and the layering predictable: each `ui.<domain>` namespace tracks one
doc-API namespace.

- `TrackChangesItem` carries only tracked changes (no `kind` discriminator)
- `TrackChangesSlice` exposes `items` / `total` / `activeId`
- `TrackChangesHandle` keeps `accept` / `reject` / `acceptAll` / `rejectAll`
  / `next` / `previous` / `scrollTo`
- `useSuperDocReview` becomes `useSuperDocTrackChanges`
- Demo's ActivitySidebar merges the two slices locally
@caio-pizzol caio-pizzol requested a review from a team as a code owner April 30, 2026 20:19
@linear
Copy link
Copy Markdown

linear Bot commented Apr 30, 2026

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@caio-pizzol caio-pizzol merged commit 2839ba8 into stable Apr 30, 2026
63 checks passed
@caio-pizzol caio-pizzol deleted the caio/sd-2667-ui-track-changes-rename-stable branch April 30, 2026 20:50
@superdoc-bot
Copy link
Copy Markdown
Contributor

superdoc-bot Bot commented Apr 30, 2026

🎉 This PR is included in superdoc v1.30.1

The release is available on GitHub release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants