-
Notifications
You must be signed in to change notification settings - Fork 367
docs: rename skip link anchor #_top → #main-content (WCAG 2.4.1)
#28618
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.
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
pelikhan
merged 2 commits into
main
from
copilot/update-multi-device-docs-testing-report
Apr 26, 2026
+47
−1
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /** | ||
| * Skip Link Accessibility Enhancement | ||
| * | ||
| * Starlight renders the main content inside a `<main>` element but does not | ||
| * expose a stable `id` on it. The page title heading receives `id="_top"` by | ||
| * default, which the custom SkipLink component previously targeted. The name | ||
| * `_top` implies "top of page" rather than "main content", creating ambiguity | ||
| * for assistive technology users (WCAG 2.4.1). | ||
| * | ||
| * This script adds `id="main-content"` and `tabindex="-1"` to the `<main>` | ||
| * element so that the skip link (`href="#main-content"`) lands on the correct | ||
| * landmark and keyboard focus is reliably placed there. The `tabindex="-1"` | ||
| * attribute makes the element programmatically focusable without including it | ||
| * in the natural tab order. | ||
| * | ||
| * The enhancement is applied on every page load and re-applied on Astro | ||
| * client-side navigation so it works across all pages and navigations. | ||
| */ | ||
|
|
||
| function enhanceMainLandmark(): void { | ||
| const main = document.querySelector<HTMLElement>('main'); | ||
| if (!main) { | ||
| return; | ||
| } | ||
| if (!main.id) { | ||
| main.id = 'main-content'; | ||
| } | ||
| if (!main.hasAttribute('tabindex')) { | ||
| main.setAttribute('tabindex', '-1'); | ||
| } | ||
| } | ||
|
|
||
| // Run on initial page load | ||
| if (document.readyState === 'loading') { | ||
| document.addEventListener('DOMContentLoaded', enhanceMainLandmark); | ||
| } else { | ||
| enhanceMainLandmark(); | ||
| } | ||
|
|
||
| // Re-run on Astro client-side navigation | ||
| document.addEventListener('astro:page-load', enhanceMainLandmark); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docstring says the script “adds
id="main-content"andtabindex="-1"to the<main>element”, but the implementation only adds them when the attributes are missing. Either update the comment to reflect the conditional behavior, or change the implementation to always enforce the expected target (#main-content).This issue also appears on line 25 of the same file.