diff options
| author | HiDeoo | 2023-08-14 20:46:40 +0200 |
|---|---|---|
| committer | GitHub | 2023-08-14 20:46:40 +0200 |
| commit | 5e3133c42232b201b981cf4b3bc1c3dd56b09fa5 (patch) | |
| tree | e28e85420abc47b1ea7feb97d0bc2d81a1f1d8e7 | |
| parent | d3a3613c8aa7cfd93f16e1a5b674f1f6594ae454 (diff) | |
| download | IT.starlight-5e3133c42232b201b981cf4b3bc1c3dd56b09fa5.tar.gz IT.starlight-5e3133c42232b201b981cf4b3bc1c3dd56b09fa5.tar.bz2 IT.starlight-5e3133c42232b201b981cf4b3bc1c3dd56b09fa5.zip | |
Improve table of content current item highlight behavior (#506)
| -rw-r--r-- | .changeset/fair-tips-reply.md | 5 | ||||
| -rw-r--r-- | packages/starlight/components/TableOfContents/TableOfContentsList.astro | 2 | ||||
| -rw-r--r-- | packages/starlight/components/TableOfContents/generateToC.ts | 3 |
3 files changed, 7 insertions, 3 deletions
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) => ( <li> - <a href={'#' + heading.slug} aria-current={heading.current && 'true'}> + <a href={'#' + heading.slug}> <span>{heading.text}</span> </a> {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) { |