Fix a sidebar persistence issue when navigating between pages with di…

…fferent sidebars (#2219)
withastro · Aug 16, 2024 · 74d4716 · 74d4716
1 parent 96d5967
commit 74d4716
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/.changeset/lemon-ants-bow.md b/.changeset/lemon-ants-bow.md
@@ -0,0 +1,5 @@
+---
+'@astrojs/starlight': patch
+---
+
+Fixes a sidebar persistence issue when navigating between pages with different sidebar content.
diff --git a/packages/starlight/components/SidebarPersistState.ts b/packages/starlight/components/SidebarPersistState.ts
@@ -16,17 +16,19 @@ interface SidebarState {
 /**
  * Get the current sidebar state.
  *
- * The `open` state is loaded from session storage, while `scroll` and `hash` are read from the current page.
+ * The `open` state is loaded from session storage when the sidebar hashes match, while `scroll`
+ * and `hash` are read from the current page.
  */
 const getState = (): SidebarState => {
 	let open = [];
+	const hash = target?.dataset.hash || '';
 	try {
 		const rawStoredState = sessionStorage.getItem(storageKey);
 		const storedState = JSON.parse(rawStoredState || '{}');
-		if (Array.isArray(storedState.open)) open = storedState.open;
+		if (Array.isArray(storedState.open) && storedState.hash === hash) open = storedState.open;
 	} catch {}
 	return {
-		hash: target?.dataset.hash || '',
+		hash,
 		open,
 		scroll: scroller?.scrollTop || 0,
 	};