Skip to content

🐛 Handle scrolling to initial hash state in table of contents #1070

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
arkadiy93 merged 1 commit into from
Apr 24, 2025
Merged

🐛 Handle scrolling to initial hash state in table of contents #1070

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
35 changes: 29 additions & 6 deletions src/providers/TableOfContentsProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ export interface TableOfContentsProviderProps {
children: ReactNode;
hashNavigation?: boolean;
}

export const TableOfContentsProvider: FC<TableOfContentsProviderProps> = ({
items,
children,
Expand All @@ -62,6 +61,7 @@ export const TableOfContentsProvider: FC<TableOfContentsProviderProps> = ({
const [selected, setSelected] = useState<string | undefined>(items[0]?.value);
const [elements, setElements] = useState<(Element | null)[]>([]);
const [shouldInstantlyJump, setShouldInstantlyJump] = useState(hash !== '');
const initHashStateRef = useRef(false);

const values: string[] = useMemo(
() => items.flatMap((item) => getValues([], item)),
Expand All @@ -73,6 +73,11 @@ export const TableOfContentsProvider: FC<TableOfContentsProviderProps> = ({
setElements(values.map((value) => document.getElementById(value)));
}, [values]);

useEffect(() => {
if (hash.length) return;
initHashStateRef.current = true;
}, [hash]);

const isActive = useCallback(
(item: TableOfContentsItemType) => {
if (item.value === selected) return true;
Expand Down Expand Up @@ -154,12 +159,30 @@ export const TableOfContentsProvider: FC<TableOfContentsProviderProps> = ({
newSelectedIndex = index;
}
}
if (newSelectedIndex !== -1 && values.at(newSelectedIndex) !== undefined) {
setSelected(values[newSelectedIndex]);
if (hashNavigation) {
navigate(`#${values[newSelectedIndex]}`, { replace: true });
}

if (newSelectedIndex === -1 || values.at(newSelectedIndex) === undefined)
return;

const targetValue = hash.replace('#', '');
if (
!initHashStateRef.current &&
targetValue.length &&
values.includes(targetValue)
) {
handleSetSelected(targetValue, {
behavior: 'instant',
shouldInstantlyJumpOnMount: true,
});
initHashStateRef.current = true;
return;
}

setSelected(values[newSelectedIndex]);
if (hashNavigation) {
navigate(`#${values[newSelectedIndex]}`, { replace: true });
}
// this effect handles scroll navigation and should not be triggered on hash change
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [hashNavigation, navigate, values, visible]);
/* v8 ignore end */

Expand Down
Loading