Skip to content

[Enhancement]: Add "skip to table of contents" #1745

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

Closed
wants to merge 1 commit into from
Closed

[Enhancement]: Add "skip to table of contents" #1745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ export const SKIP_TO_CONTENT_ID = 'skip-to-content'

export const SKIP_TO_SEARCH_ID = 'search-box-input'

export const SKIP_TO_TOC_ID = 'toc-heading'

export const CLI_PATH = '/cli'

export const Z_INDEX = {
Expand Down
7 changes: 6 additions & 1 deletion src/page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Slugger from 'github-slugger'
import Header from './components/header'
import Sidebar from './components/sidebar'
import {SkipBox, SkipLink} from './components/skip-nav'
import {SKIP_TO_CONTENT_ID, SKIP_TO_SEARCH_ID} from './constants'
import {SKIP_TO_CONTENT_ID, SKIP_TO_SEARCH_ID, SKIP_TO_TOC_ID} from './constants'

import {PageProvider} from './hooks/use-page'
import Layout from './layout'
Expand All @@ -25,12 +25,17 @@ const PageElement = ({element, props}) => {
path: props.location.pathname,
slugger: new Slugger(),
}

// Check if table of contents is available and has items
const hasTableOfContents = Boolean(props.pageContext?.tableOfContents?.length)

return (
<BaseStyles>
<GlobalStyles />
<SkipBox>
<SkipLink href={`#${SKIP_TO_SEARCH_ID}`}>Skip to search</SkipLink>
<SkipLink href={`#${SKIP_TO_CONTENT_ID}`}>Skip to content</SkipLink>
{hasTableOfContents && <SkipLink href={`#${SKIP_TO_TOC_ID}`}>Skip to table of contents</SkipLink>}
</SkipBox>
<PageProvider value={page}>
<Box sx={{display: 'flex', flexDirection: 'column', minHeight: '100vh'}}>
Expand Down
Loading