Skip to content

fix(a11y): add skip link to main content #3117

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

Open
leno23 wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −3
Open

fix(a11y): add skip link to main content #3117

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
16 changes: 16 additions & 0 deletions crates/mdbook-html/front-end/css/chrome.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
/* CSS for UI elements (a.k.a. chrome) */

.skip-to-content {
position: absolute;
top: -100px;
left: 0;
padding: 0.5rem 1rem;
background-color: var(--bg);
color: var(--fg);
z-index: 1000;
text-decoration: none;
border: 2px solid var(--links);
}

.skip-to-content:focus {
top: 0;
}

html {
scrollbar-color: var(--scrollbar) transparent;
}
Expand Down
7 changes: 4 additions & 3 deletions crates/mdbook-html/front-end/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
<script src="{{ resource "toc.js" }}"></script>
</head>
<body>
<a class="skip-to-content" href="#mdbook-content">Skip to main content</a>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
Expand Down Expand Up @@ -143,9 +144,9 @@
<div id="mdbook-menu-bar-hover-placeholder"></div>
<div id="mdbook-menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
<button id="mdbook-sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
{{fa "solid" "bars"}}
</label>
</button>
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
{{fa "solid" "paintbrush"}}
</button>
Expand Down Expand Up @@ -213,7 +214,7 @@
});
</script>

<div id="mdbook-content" class="content">
<div id="mdbook-content" class="content" tabindex="-1">
<main>
{{{ content }}}
</main>
Expand Down
Loading