diff options
| author | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:05:12 -0400 |
|---|---|---|
| committer | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:05:12 -0400 |
| commit | 6b742c459266b18e2b375b35205ce8a6c02f0452 (patch) | |
| tree | b16fbb9a045e33dd6c97eb5ab72e6ff4d9237ea3 /build/skip-to-content | |
Initial commit
Diffstat (limited to 'build/skip-to-content')
| -rw-r--r-- | build/skip-to-content/index.html | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/build/skip-to-content/index.html b/build/skip-to-content/index.html new file mode 100644 index 0000000..be50b94 --- /dev/null +++ b/build/skip-to-content/index.html @@ -0,0 +1,86 @@ +<!doctype html> +<html lang="en" id="top"> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="data:,"> + <title>Skip to Content Button</title> + <link href="https://bt.ht/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}table{text-align:left;width:100%;}</style> +</head> + +<nav> + <a href="#menu">Menu ↓</a> +</nav> + +<main> +<h1>Skip to Content Button</h1> +<p>2019-03-25</p> +<p>One of the golden rules for testing your website's accessibility is the "keyboard-only" audit. This is where you test navigating through your entire site without the use of a mouse, but instead rely solely on tabbing through your content.</p> +<p>Unfortunately, one item is normally overlooked during this audit - a "skip to content" context button. Including a "skip to content" navigation item in your project is extremely useful because:</p> +<ul> +<li>speeds up user interaction with the content you <strong>want</strong> them to see</li> +<li>on subsequent pages the user shouldn't need to tab through the entire navigation each time</li> +</ul> +<h2>The HTML</h2> +<p>For the sake of this demo we will assume that we currently have the following navigation setup in our project:</p> +<pre><code><nav role="navigation"> + <a href="/">Home</a> + <a href="/about">About</a> + <a href="/archive">Archive</a> + <a href="/atom.xml">RSS</a> +</nav> +</code></pre> +<p>Now for the easy part - adding our simple content skip link with it's own custom <code>skip-content</code> class:</p> +<pre><code><nav role="navigation"> + <!-- Skip to content button --> + <a class="skip-content" href="#main">Skip to Content (Press Enter)</a> + <a href="/">Home</a> + <a href="/about">About</a> + <a href="/archive">Archive</a> + <a href="/atom.xml">RSS</a> +</nav> +</code></pre> +<p><div class="message"> + <strong>Sidenote:</strong> in this demo we are making the assumption that the main content block has an <code>id</code> of "main" associated with it. Hence the skip content button linking to <code>#main</code>. +</div></p> +<h2>The CSS</h2> +<p>Our first task is to make sure this new link isn't visible or interactive by default unless the user explicitly tabs through the navigation. We do so by positioning the link outside of the main content view. It is important to use this <code>absolute</code> position style instead of setting the display property to <code>none</code>, since the display property technique will fully remove the element from the DOM (bad accessibility practices).</p> +<pre><code>a.skip-content { + background: grey; + color: white; + left: -9999px; + padding: 0.5rem; + position: absolute; + top: 0; +} +</code></pre> +<h2>Almost there</h2> +<p>Now we just re-position the element when the user focuses on the link with a keyboard tab:</p> +<pre><code>a.skip-content:focus { + left: 1rem; /* Whatever desired position */ +} +</code></pre> +<h2>All Done</h2> +<p>This is a very basic accessibility win you can implement in your current projects with next to zero effort. Enjoy!</p> +<footer role="contentinfo"> + <h2>Menu Navigation</h2> + <ul id="menu"> + <li><a href="/">Home</a></li> + <li><a href="/projects">Projects</a></li> + <li><a href="/uses">Uses</a></li> + <li><a href="/wiki">Wiki</a></li> + <li><a href="/resume">Resume</a></li> + <li><a href="/colophon">Colophon</a></li> + <li><a href="/now">Now</a></li> + <li><a href="/donate">Donate</a></li> + <li><a href="/atom.xml">RSS</a></li> + <li><a href="#top">↑ Top of the page</a></li> + </ul> + <small> + Built with <a href="https://git.sr.ht/~bt/barf">barf</a>. <br> + Maintained with ♥ for the web. <br> + Proud supporter of <a href="https://usefathom.com/ref/DKHJVX">Fathom</a> & <a href="https://nextdns.io/?from=74d3p3h8">NextDNS</a>. <br> + The content for this site is <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>.<br> The <a href="https://git.sr.ht/~bt/bt.ht">code for this site</a> is <a href="https://git.sr.ht/~bt/bt.ht/tree/master/item/LICENSE">MIT</a>. + </small> +</footer>
\ No newline at end of file |