@astrojs/starlight 0.10.0 → 0.10.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @astrojs/starlight
 
+## 0.10.1
+
+### Patch Changes
+
+- [#726](https://github.com/withastro/starlight/pull/726) [`f3157c6`](https://github.com/withastro/starlight/commit/f3157c6065943af39995b6dbae5f63cf424bd9a3) Thanks [@delucis](https://github.com/delucis)! - Fix a rare bug in table of contents when handling headings that increase by more than one level on a page.
+
+- [#729](https://github.com/withastro/starlight/pull/729) [`80c6ab1`](https://github.com/withastro/starlight/commit/80c6ab1c1ec48805e74c53b615a78d65127eeacb) Thanks [@delucis](https://github.com/delucis)! - Upgrade Pagefind to v1.0.3
+
+- [#715](https://github.com/withastro/starlight/pull/715) [`e726155`](https://github.com/withastro/starlight/commit/e7261559f2539a0ceefd36a28e4fbbc17f5970b8) Thanks [@itsmatteomanf](https://github.com/itsmatteomanf)! - feat: prevent scroll on body when search is open
+
 ## 0.10.0
 
 ### Minor Changes

package/components/Search.astro

@@ -72,20 +72,23 @@ const pagefindTranslations = {
 
 			const openModal = (event?: MouseEvent) => {
 				dialog.showModal();
+				document.body.toggleAttribute('data-search-modal-open', true);
 				this.querySelector('input')?.focus();
 				event?.stopPropagation();
 				window.addEventListener('click', onClick);
 			};
 
-			const closeModal = () => {
-				dialog.close();
-				window.removeEventListener('click', onClick);
-			};
+			const closeModal = () => dialog.close();
 
 			openBtn.addEventListener('click', openModal);
 			openBtn.disabled = false;
 			closeBtn.addEventListener('click', closeModal);
 
+			dialog.addEventListener('close', () => {
+				document.body.toggleAttribute('data-search-modal-open', false);
+				window.removeEventListener('click', onClick);
+			});
+
 			// Listen for `/` and `cmd + k` keyboard shortcuts.
 			window.addEventListener('keydown', (e) => {
 				const isInput =
@@ -230,6 +233,10 @@ const pagefindTranslations = {
 </style>
 
 <style is:global>
+	[data-search-modal-open] {
+		overflow: hidden;
+	}
+
 	#starlight__search {
 		--sl-search-result-spacing: calc(1.25rem * var(--pagefind-ui-scale));
 		--sl-search-result-pad-inline-start: calc(3.75rem * var(--pagefind-ui-scale));

package/components/TableOfContents/generateToC.ts

@@ -4,52 +4,29 @@ export interface TocItem extends MarkdownHeading {
 	children: TocItem[];
 }
 
-function diveChildren(item: TocItem, depth: number): TocItem[] {
-	if (depth === 1) {
-		return item.children;
-	} else if (item.children.length > 0) {
-		return diveChildren(item.children.at(-1)!, depth - 1);
-	} else {
-		return [];
-	}
-}
-
 interface TocOpts {
 	minHeadingLevel: number;
 	maxHeadingLevel: number;
-	title?: string;
+	title: string;
 }
 
+/** Convert the flat headings array generated by Astro into a nested tree structure. */
 export function generateToC(
 	headings: MarkdownHeading[],
-	{ minHeadingLevel, maxHeadingLevel, title = 'Overview' }: TocOpts
+	{ minHeadingLevel, maxHeadingLevel, title }: TocOpts
 ) {
-	const overview = { depth: 2, slug: '_top', text: title };
-	headings = [
-		overview,
-		...headings.filter(({ depth }) => depth >= minHeadingLevel && depth <= maxHeadingLevel),
-	];
-	const toc: Array<TocItem> = [];
+	headings = headings.filter(({ depth }) => depth >= minHeadingLevel && depth <= maxHeadingLevel);
+	const toc: Array<TocItem> = [{ depth: 2, slug: '_top', text: title, children: [] }];
+	for (const heading of headings) injectChild(toc, { ...heading, children: [] });
+	return toc;
+}
 
-	for (const heading of headings) {
-		if (toc.length === 0) {
-			toc.push({ ...heading, children: [] });
-		} else {
-			const lastItemInToc = toc.at(-1)!;
-			if (heading.depth < lastItemInToc.depth) {
-				throw new Error(`Orphan heading found: ${heading.text}.`);
-			}
-			if (heading.depth === lastItemInToc.depth) {
-				// same depth
-				toc.push({ ...heading, children: [] });
-			} else {
-				// higher depth
-				// push into children, or children's children alike
-				const gap = heading.depth - lastItemInToc.depth;
-				const target = diveChildren(lastItemInToc, gap);
-				target.push({ ...heading, children: [] });
-			}
-		}
+/** Inject a ToC entry as deep in the tree as its `depth` property requires. */
+function injectChild(items: TocItem[], item: TocItem): void {
+	const lastItem = items.at(-1);
+	if (!lastItem || lastItem.depth >= item.depth) {
+		items.push(item);
+	} else {
+		return injectChild(lastItem.children, item);
 	}
-	return toc;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -39,13 +39,13 @@
   "dependencies": {
     "@astrojs/mdx": "^1.0.0",
     "@astrojs/sitemap": "^3.0.0",
-    "@pagefind/default-ui": "^1.0.2",
+    "@pagefind/default-ui": "^1.0.3",
     "@types/mdast": "^3.0.11",
     "bcp-47": "^2.1.0",
     "execa": "^7.1.1",
     "hast-util-select": "^5.0.5",
     "hastscript": "^7.2.0",
-    "pagefind": "^1.0.2",
+    "pagefind": "^1.0.3",
     "rehype": "^12.0.1",
     "remark-directive": "^2.0.1",
     "unified": "^10.1.2",