Skip to content

a11y- Use nested list for <h3> links within the table of contents #7883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 25, 2024
Merged

a11y- Use nested list for <h3> links within the table of contents #7883

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
db4aac8
nest toc h3 beneath h2
Aug 9, 2024
93107af
fix improperly nested headings
Aug 12, 2024
40d149d
fix remaining heading level issues
Aug 14, 2024
a038fce
Merge branch 'main' into a11y-toc-nested
katieklein Sep 5, 2024
d0aaa51
fix heading level
Sep 26, 2024
4d9f55e
merge latest
hbuchel Oct 24, 2024
6398f15
remove stray empty line
hbuchel Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/components/Layout/Layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,15 @@ export const Layout = ({

pageHeadings.forEach((node) => {
const { innerText, id, localName } = node as HTMLElement;
if (innerText && id && (localName == 'h2' || localName == 'h3')) {
if (innerText && id && localName == 'h2') {
headings.push({
linkText: innerText,
hash: id,
level: localName,
subheadings: []
});
} else if (innerText && id && localName == 'h3') {
headings[headings.length - 1].subheadings.push({
linkText: innerText,
hash: id,
level: localName
Expand Down
64 changes: 51 additions & 13 deletions src/components/TableOfContents/TableOfContents.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export interface HeadingInterface {
linkText: string;
hash: string;
level: string;
subheadings: Array<object>;
}
interface TableOfContents {
headers?: HeadingInterface[];
Expand All @@ -21,20 +22,57 @@ export const TableOfContents = ({ headers }) => {
)}
<View as="ul" className="toc-list">
{headers.map(({ linkText, hash, level }, index) => {
return (
<View
as="li"
className={`toc-item toc-item--${level}`}
key={`toc-${index}`}
>
<Link
href={`#${hash}`}
className={`toc-item__link toc-item__link--${level}`}
if (headers[index].subheadings?.length === 0) {
return (
<View
as="li"
className={`toc-item toc-item--${level}`}
key={`toc-${index}`}
>
{linkText}
</Link>
</View>
);
<Link
href={`#${hash}`}
className={`toc-item__link toc-item__link--${level}`}
>
{linkText}
</Link>
</View>
);
} else {
return (
<View
as="li"
className={`toc-item toc-item--${level}`}
key={`toc-${index}`}
>
<Link
href={`#${hash}`}
className={`toc-item__link toc-item__link--${level}`}
>
{linkText}
</Link>
<View as="ul" className="toc-list">
{headers[index].subheadings?.map(
({ linkText, hash, level }, index) => {
return (
<View
as="li"
className={`toc-item toc-item--${level}`}
key={`toc-${index}`}
>
<Link
href={`#${hash}`}
className={`toc-item__link toc-item__link--${level}`}
>
{linkText}
</Link>
</View>
);
}
)}
</View>
</View>
);
}
})}
</View>
</Flex>
Expand Down