summaryrefslogtreecommitdiff
path: root/examples/docs/src/components/RightSidebar/TableOfContents.tsx
diff options
context:
space:
mode:
authorGravatar Nate Moore <natemoo-re@users.noreply.github.com> 2022-07-23 17:23:15 -0500
committerGravatar GitHub <noreply@github.com> 2022-07-23 17:23:15 -0500
commit6e27a5fdc21276cad26cd50e16a2709a40a7cbac (patch)
tree65658fee080c5f8dfa06903cefc3d9736db6f409 /examples/docs/src/components/RightSidebar/TableOfContents.tsx
parent1215e731b8a334fce364aca77bda1085f3679e57 (diff)
downloadastro-6e27a5fdc21276cad26cd50e16a2709a40a7cbac.tar.gz
astro-6e27a5fdc21276cad26cd50e16a2709a40a7cbac.tar.zst
astro-6e27a5fdc21276cad26cd50e16a2709a40a7cbac.zip
Rename Markdown util `getHeaders()` to `getHeadings()` (#4031)
* Renamed getHeaders() to getHeadings(), according to RFC #208. * chore: update changeset * fix: expose MarkdownHeading type from `astro` Co-authored-by: Félix Sanz <me@felixsanz.com> Co-authored-by: Nate Moore <nate@astro.build>
Diffstat (limited to 'examples/docs/src/components/RightSidebar/TableOfContents.tsx')
-rw-r--r--examples/docs/src/components/RightSidebar/TableOfContents.tsx16
1 files changed, 8 insertions, 8 deletions
diff --git a/examples/docs/src/components/RightSidebar/TableOfContents.tsx b/examples/docs/src/components/RightSidebar/TableOfContents.tsx
index 537508ab4..1d74e820f 100644
--- a/examples/docs/src/components/RightSidebar/TableOfContents.tsx
+++ b/examples/docs/src/components/RightSidebar/TableOfContents.tsx
@@ -1,11 +1,11 @@
import type { FunctionalComponent } from 'preact';
import { h, Fragment } from 'preact';
import { useState, useEffect, useRef } from 'preact/hooks';
+import { MarkdownHeading } from 'astro';
-const TableOfContents: FunctionalComponent<{ headers: any[] }> = ({ headers = [] }) => {
+const TableOfContents: FunctionalComponent<{ headings: MarkdownHeading[] }> = ({ headings = [] }) => {
const itemOffsets = useRef([]);
const [activeId, setActiveId] = useState<string>(undefined);
-
useEffect(() => {
const getItemOffsets = () => {
const titles = document.querySelectorAll('article :is(h1, h2, h3, h4)');
@@ -27,18 +27,18 @@ const TableOfContents: FunctionalComponent<{ headers: any[] }> = ({ headers = []
<>
<h2 class="heading">On this page</h2>
<ul>
- <li class={`header-link depth-2 ${activeId === 'overview' ? 'active' : ''}`.trim()}>
+ <li class={`heading-link depth-2 ${activeId === 'overview' ? 'active' : ''}`.trim()}>
<a href="#overview">Overview</a>
</li>
- {headers
+ {headings
.filter(({ depth }) => depth > 1 && depth < 4)
- .map((header) => (
+ .map((heading) => (
<li
- class={`header-link depth-${header.depth} ${
- activeId === header.slug ? 'active' : ''
+ class={`heading-link depth-${heading.depth} ${
+ activeId === heading.slug ? 'active' : ''
}`.trim()}
>
- <a href={`#${header.slug}`}>{header.text}</a>
+ <a href={`#${heading.slug}`}>{heading.text}</a>
</li>
))}
</ul>