Skip to content

[DevTools] Explicitly say which id to scroll to and only once #34823

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
merged 1 commit into from
Oct 13, 2025
Merged

[DevTools] Explicitly say which id to scroll to and only once #34823

Show file tree
Hide file tree
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
27 changes: 12 additions & 15 deletions packages/react-devtools-shared/src/devtools/views/SuspenseTab/SuspenseTimeline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
*/

import * as React from 'react';
import {useContext, useEffect, useRef} from 'react';
import {useContext, useEffect} from 'react';
import {BridgeContext} from '../context';
import {TreeDispatcherContext} from '../Components/TreeContext';
import {useHighlightHostInstance, useScrollToHostInstance} from '../hooks';
Expand All @@ -29,9 +29,8 @@ function SuspenseTimelineInput() {
useHighlightHostInstance();
const scrollToHostInstance = useScrollToHostInstance();

const {timeline, timelineIndex, hoveredTimelineIndex, playing} = useContext(
SuspenseTreeStateContext,
);
const {timeline, timelineIndex, hoveredTimelineIndex, playing, autoScroll} =
useContext(SuspenseTreeStateContext);

const min = 0;
const max = timeline.length > 0 ? timeline.length - 1 : 0;
Expand Down Expand Up @@ -102,7 +101,6 @@ function SuspenseTimelineInput() {
});
}

const isInitialMount = useRef(true);
// TODO: useEffectEvent here once it's supported in all versions DevTools supports.
// For now we just exclude it from deps since we don't lint those anyway.
function changeTimelineIndex(newIndex: number) {
Expand All @@ -115,22 +113,21 @@ function SuspenseTimelineInput() {
bridge.send('overrideSuspenseMilestone', {
suspendedSet,
});
if (isInitialMount.current) {
// Skip scrolling on initial mount. Only when we're changing the timeline.
isInitialMount.current = false;
} else {
// When we're scrubbing through the timeline, scroll the current boundary
// into view as it was just revealed. This is after we override the milestone
// to reveal it.
const selectedSuspenseID = timeline[timelineIndex];
scrollToHostInstance(selectedSuspenseID);
}
}

useEffect(() => {
changeTimelineIndex(timelineIndex);
}, [timelineIndex]);

useEffect(() => {
if (autoScroll.id > 0) {
const scrollToId = autoScroll.id;
// Consume the scroll ref so that we only trigger this scroll once.
autoScroll.id = 0;
scrollToHostInstance(scrollToId);
}
}, [autoScroll]);

useEffect(() => {
if (!playing) {
return undefined;
Expand Down
7 changes: 7 additions & 0 deletions packages/react-devtools-shared/src/devtools/views/SuspenseTab/SuspenseTreeContext.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export type SuspenseTreeState = {
uniqueSuspendersOnly: boolean,
playing: boolean,
autoSelect: boolean,
autoScroll: {id: number}, // Ref that's set to 0 after scrolling once.
};

type ACTION_SUSPENSE_TREE_MUTATION = {
Expand Down Expand Up @@ -125,6 +126,7 @@ function getInitialState(store: Store): SuspenseTreeState {
uniqueSuspendersOnly,
playing: false,
autoSelect: true,
autoScroll: {id: 0}, // Don't auto-scroll initially
};

return initialState;
Expand Down Expand Up @@ -218,6 +220,7 @@ function SuspenseTreeContextController({children}: Props): React.Node {
selectedSuspenseID,
playing: false, // pause
autoSelect: false,
autoScroll: {id: selectedSuspenseID}, // scroll
};
}
case 'SET_SUSPENSE_LINEAGE': {
Expand Down Expand Up @@ -285,6 +288,7 @@ function SuspenseTreeContextController({children}: Props): React.Node {
timelineIndex: nextTimelineIndex,
playing: false, // pause
autoSelect: false,
autoScroll: {id: nextSelectedSuspenseID}, // scroll
};
}
case 'SUSPENSE_SKIP_TIMELINE_INDEX': {
Expand All @@ -308,6 +312,7 @@ function SuspenseTreeContextController({children}: Props): React.Node {
timelineIndex: nextTimelineIndex,
playing: false, // pause
autoSelect: false,
autoScroll: {id: nextSelectedSuspenseID}, // scroll
};
}
case 'SUSPENSE_PLAY_PAUSE': {
Expand Down Expand Up @@ -359,6 +364,7 @@ function SuspenseTreeContextController({children}: Props): React.Node {
selectedSuspenseID: nextSelectedSuspenseID,
timelineIndex: nextTimelineIndex,
playing: nextPlaying,
autoScroll: {id: nextSelectedSuspenseID}, // scroll
};
}
case 'TOGGLE_TIMELINE_FOR_ID': {
Expand Down Expand Up @@ -392,6 +398,7 @@ function SuspenseTreeContextController({children}: Props): React.Node {
timelineIndex: nextTimelineIndex,
playing: false, // pause
autoSelect: false,
autoScroll: {id: nextSelectedSuspenseID},
};
}
case 'HOVER_TIMELINE_FOR_ID': {
Expand Down
Loading