DataGrid: split scroll/scroll to position/should focus position handling into hooks #3986
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import { useCallback, useSyncExternalStore } from 'react'; | ||
|
|
||
| import { abs } from '../utils'; | ||
|
|
||
| interface ScrollState { | ||
| readonly scrollTop: number; | ||
| readonly scrollLeft: number; | ||
| } | ||
|
|
||
| const initialScrollState: ScrollState = { | ||
| scrollTop: 0, | ||
| scrollLeft: 0 | ||
| }; | ||
|
|
||
| function getServerSnapshot() { | ||
| return initialScrollState; | ||
| } | ||
|
|
||
| const scrollStateMap = new WeakMap<React.RefObject<HTMLDivElement | null>, ScrollState>(); | ||
|
Collaborator
There was a problem hiding this comment. Is there a benefit of using a map instead of setting a local state inside the component?
Collaborator
Author
There was a problem hiding this comment. Are you suggesting we keep using
Collaborator
Author
There was a problem hiding this comment. function Test() {
const [resolvers, setResolvers] = useState<PromiseWithResolvers<void>>(() =>
Promise.withResolvers()
);
return (
<>
<button type="button" onClick={() => setResolvers(Promise.withResolvers())}>
New promise
</button>
<button type="button" onClick={() => resolvers.resolve()}>
Resolve
</button>
<Suspense fallback="Loading...">
<Inner promise={resolvers.promise} />
</Suspense>
</>
);
}
function Inner({ promise }: { promise: Promise<void> }) {
useState(() => {
console.log('init state');
});
use(promise);
return 'ok';
}In this example the This also happens when the suspense is triggered deeper in the tree: function Inner({ promise }: { promise: Promise<void> }) {
useState(() => {
console.log('init state');
});
// use(promise);
return (
<>
<InnerSide />
<InnerDeep promise={promise} />
</>
);
}
function subscribe() {
console.log('subscribe');
return () => {
console.log('unsubscribe');
};
}
function getSnapshot() {
console.log('get snapshot');
}
function InnerSide() {
useState(() => {
console.log('init state side');
});
useSyncExternalStore(subscribe, getSnapshot);
return 'side';
}
function InnerDeep({ promise }: { promise: Promise<void> }) {
useState(() => {
console.log('init state deep');
});
use(promise);
return 'ok';
}React only stops re-initializing states when it renders the tree under All that to say... I guess it's slightly better to have a single WeakMap?
Collaborator
There was a problem hiding this comment. Does this mean a single WeakMap would be more performant or prevent some edge cases? |
||
|
|
||
| export function useScrollState(gridRef: React.RefObject<HTMLDivElement | null>): ScrollState { | ||
| const subscribe = useCallback( | ||
| (onStoreChange: () => void) => { | ||
| if (gridRef.current === null) return () => {}; | ||
|
|
||
| const el = gridRef.current; | ||
|
|
||
| // prime the scroll state map with the initial values | ||
| setScrollState(); | ||
|
|
||
| function setScrollState() { | ||
| const { scrollTop } = el; | ||
| // scrollLeft is negative when direction is rtl | ||
| const scrollLeft = abs(el.scrollLeft); | ||
|
|
||
| const prev = scrollStateMap.get(gridRef) ?? initialScrollState; | ||
| if (prev.scrollTop === scrollTop && prev.scrollLeft === scrollLeft) { | ||
| return false; | ||
| } | ||
|
|
||
| scrollStateMap.set(gridRef, { scrollTop, scrollLeft }); | ||
| return true; | ||
| } | ||
|
|
||
| function onScroll() { | ||
| if (setScrollState()) { | ||
| onStoreChange(); | ||
| } | ||
| } | ||
|
|
||
| el.addEventListener('scroll', onScroll); | ||
|
|
||
| return () => el.removeEventListener('scroll', onScroll); | ||
| }, | ||
| [gridRef] | ||
| ); | ||
|
|
||
| const getSnapshot = useCallback((): ScrollState => { | ||
| // gridRef.current is null during initial render, suspending, or <Activity mode="hidden"> | ||
| // to avoid returning a different state in those cases, | ||
| // we key the ref object instead of the element itself | ||
| return scrollStateMap.get(gridRef) ?? initialScrollState; | ||
| }, [gridRef]); | ||
|
|
||
| return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot); | ||
|
Collaborator
Author
There was a problem hiding this comment. Scroll state now uses |
||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍