From 5e3133c42232b201b981cf4b3bc1c3dd56b09fa5 Mon Sep 17 00:00:00 2001 From: HiDeoo Date: Mon, 14 Aug 2023 20:46:40 +0200 Subject: Improve table of content current item highlight behavior (#506) --- .changeset/fair-tips-reply.md | 5 +++++ .../starlight/components/TableOfContents/TableOfContentsList.astro | 2 +- packages/starlight/components/TableOfContents/generateToC.ts | 3 +-- 3 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 .changeset/fair-tips-reply.md diff --git a/.changeset/fair-tips-reply.md b/.changeset/fair-tips-reply.md new file mode 100644 index 00000000..f61c6172 --- /dev/null +++ b/.changeset/fair-tips-reply.md @@ -0,0 +1,5 @@ +--- +'@astrojs/starlight': patch +--- + +Improve table of content current item highlight behavior diff --git a/packages/starlight/components/TableOfContents/TableOfContentsList.astro b/packages/starlight/components/TableOfContents/TableOfContentsList.astro index 27623c64..7c290a1e 100644 --- a/packages/starlight/components/TableOfContents/TableOfContentsList.astro +++ b/packages/starlight/components/TableOfContents/TableOfContentsList.astro @@ -14,7 +14,7 @@ const { toc, isMobile = false, depth = 0 } = Astro.props; { toc.map((heading) => (
  • - + {heading.text} {heading.children.length > 0 && ( diff --git a/packages/starlight/components/TableOfContents/generateToC.ts b/packages/starlight/components/TableOfContents/generateToC.ts index 33409be8..30d1005f 100644 --- a/packages/starlight/components/TableOfContents/generateToC.ts +++ b/packages/starlight/components/TableOfContents/generateToC.ts @@ -2,7 +2,6 @@ import type { MarkdownHeading } from 'astro'; export interface TocItem extends MarkdownHeading { children: TocItem[]; - current?: boolean; } function diveChildren(item: TocItem, depth: number): TocItem[] { @@ -34,7 +33,7 @@ export function generateToC( for (const heading of headings) { if (toc.length === 0) { - toc.push({ ...heading, children: [], current: true }); + toc.push({ ...heading, children: [] }); } else { const lastItemInToc = toc.at(-1)!; if (heading.depth < lastItemInToc.depth) { -- cgit