Repository navigation
fix(core): scope useElement re-renders to the element's own provider - #5325
Merged
Merged
Conversation
ElementProvider passed each element down through a React context whose value held its parent's value, so a new table element on every keystroke changed the context of every row and cell below it. Every useElement or usePath consumer re-rendered, including all cells of a large table. useElementContext now subscribes to the matching provider's runtime store with useSyncExternalStore. ElementProvider stages its new state during render, so children rendered in the same pass read it, and publishes it in a layout effect to the consumers that did not re-render.
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
🦋 Changeset detectedLatest commit: cefda2a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This branch was successfully deployed
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
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.
Why
ElementProviderpasses{ element, entry, path, parent }down through React context, andparentis the ancestor's context value. When the table element changes, the context of every row and cell provider below it changes too.useElement()andusePath()read that context. So every component that calls them re-renders. That includesuseTableCellElement,useTableCellElementResizable,useBlockSelectedanduseCellIndices.Change
useElementContextnow finds the matchingElementStoreContext(whose value is stable) and subscribes to that provider's runtime store withuseSyncExternalStore.ElementProviderstages its new state during render, so children rendered in the same pass read the new element. It publishes the state in a layout effect to consumers that did not re-render.withElementContextbehavior are unchanged; the existinguseElementStorespecs pass as-is.Verification
useElement.spec.tsxrenders a 3 × 3 table throughPlateContentand types into one cell:main, all 9 re-render.main, all 9 cells' layout effects run.bun test packages/core(860) andpackages/table(293) pass.@platejs/coretypecheck passes.packages/selectionfails 36 of 94 locally, the same count on untouchedmain./docs/tablewith a 200 × 10 table, where the cell also callsuseTableCellElement():mainand 4 times with this change (dev build, StrictMode).