Accessibility Plugin
A swup plugin for enhanced accessibility.
Loading new content via AJAX is a great experience for most users, but comes with serious shortcomings for screen reader users. This plugin will improve that:
- Announce page visits to screenreaders by reading the new page title
- Restore focus after swapping out the content
- Skip animations for users with a preference for reduced motion
Accessibility can be hard to get right. That's why we're keen to hear your feedback. Share your experience and suggest improvements by opening an issue on this repo. Let's make swup better together!
Installation
Install the plugin from npm and import it into your bundle.
npm install @swup/a11y-plugin
npm install @swup/a11y-plugin
import SwupA11yPlugin from '@swup/a11y-plugin';
import SwupA11yPlugin from '@swup/a11y-plugin';
Or include the minified production file from a CDN:
<script src="https://unpkg.com/@swup/a11y-plugin@4"></script>
<script src="https://unpkg.com/@swup/a11y-plugin@4"></script>
Usage
To run this plugin, include an instance in the swup options.
const swup = new Swup({
plugins: [new SwupA11yPlugin()]
});
const swup = new Swup({
plugins: [new SwupA11yPlugin()]
});
Markup
The plugin should work out of the box if you use proper semantic markup for your content, i.e. a
descriptive h1
for each page heading. See the options below for customizing what tags to look for.
<body> <!-- will be focussed -->
<header>
Logo
</header>
<main>
<h1>Page Title</h1> <!-- will be announced -->
<p>Lorem ipsum dolor sit amet</p>
</main>
</body>
<body> <!-- will be focussed -->
<header>
Logo
</header>
<main>
<h1>Page Title</h1> <!-- will be announced -->
<p>Lorem ipsum dolor sit amet</p>
</main>
</body>
Announcements
The plugin will announce the new page to screen readers after navigating to it. It will look for the following and announce the first one found:
- Heading label:
<h1 aria-label="About"></h1>
- Heading content:
<h1>About</h1>
- Document title:
<title>About</title>
- Page URL:
/about/
The easiest way to announce a page title differing from the main heading is using aria-label
. The
example below will be announced as Homepage
.
<h1 aria-label="Homepage">Project Title</h1>
<h1 aria-label="Homepage">Project Title</h1>
Options
All options with their default values:
{
headingSelector: 'h1',
respectReducedMotion: false,
autofocus: false,
announcements: {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
}
}
{
headingSelector: 'h1',
respectReducedMotion: false,
autofocus: false,
announcements: {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
}
}
headingSelector
The selector for finding page headings. The content of the first found heading will be read to screenreaders after a new page was loaded.
respectReducedMotion
Whether to respects users' preference for reduced motion.
Disable animated page transitions and animated scrolling if a user has enabled a setting on their device to minimize the amount of non-essential motion. Learn more about prefers-reduced-motion.
autofocus
Whether to focus elements with an autofocus
attribute after navigation.
Make sure to use this wisely. Automatically focussing elements can be useful to draw attention to inputs, but it comes with a list of drawbacks on its own, especially for screen-reading technology. See Autofocus accessibility considerations for details.
announcements
How the new page is announced. A visit is announced differently depending on whether the new page has a title or not. If found, the main heading or document title is announced. If neither is found, the new url will be announced instead:
- Title found? Read
announcements.visit
, replacing{title}
with the new title - No title? Read
announcements.visit
too, but replacing{title}
with the content ofannouncements.url
{
announcements: {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
}
}
{
announcements: {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
}
}
Translations
For multi-language sites, pass in a nested object keyed by locale. The locale must match the
html
element's lang attribute
exactly. Use an asterisk *
to declare fallback translations.
{
announcements: {
'en-US': {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
},
'de-DE': {
visit: 'Navigiert zu: {title}',
url: 'Neue Seite unter {url}'
},
'fr-FR': {
visit: 'Navigué vers : {title}',
url: 'Nouvelle page à {url}'
},
'*': {
visit: '{title}',
url: '{url}'
}
}
}
{
announcements: {
'en-US': {
visit: 'Navigated to: {title}',
url: 'New page at {url}'
},
'de-DE': {
visit: 'Navigiert zu: {title}',
url: 'Neue Seite unter {url}'
},
'fr-FR': {
visit: 'Navigué vers : {title}',
url: 'Nouvelle page à {url}'
},
'*': {
visit: '{title}',
url: '{url}'
}
}
}
Deprecated options
The following two options are now grouped in the announcements
object and deprecated.
announcementTemplate
: equivalent toannouncements.visit
urlTemplate
: equivalent toannouncements.url
Visit object
The plugin extends the visit object with a new a11y
key that can be used to customize the
behavior on the fly.
{
from: { ... },
to: { ... },
a11y: {
announce: 'Navigated to: About',
focus: 'body'
}
}
{
from: { ... },
to: { ... },
a11y: {
announce: 'Navigated to: About',
focus: 'body'
}
}
visit.a11y.announce
The text to announce after the new page was loaded. This is the final text after choosing the correct language from the announcements option and filling in any placeholders. Modify it to read a custom announcement.
Since the text can only be populated once the new page was fetched and its contents are available,
the only place to inspect or modify this would be right before the content:announce
hook.
swup.hooks.before('content:announce', (visit) => {
visit.a11y.announce = 'New page loaded';
});
swup.hooks.before('content:announce', (visit) => {
visit.a11y.announce = 'New page loaded';
});
visit.a11y.focus
The element to receive focus after the new page was loaded, by default the body
. Can be customized
per visit. Set it to a selector string
to select an element, or set it to false
to not move the
focus on this visit.
Hooks
The plugin adds two new hooks: content:announce
and content:focus
. Both run directly
after the internal content:replace
handler, when the new content is already in the DOM.
content:announce
Executes the announcement of the new page title.
swup.hooks.on('content:announce', () => console.log('New content was announced'));
swup.hooks.on('content:announce', () => console.log('New content was announced'));
content:focus
Executes the focussing of the new page.
swup.hooks.on('content:focus', () => console.log('New content received focus'));
swup.hooks.on('content:focus', () => console.log('New content received focus'));
Methods on the swup instance
The plugin adds the following method to the swup instance:
announce
Announce something programmatically. Use this if you are making use of
options.resolveUrl
and still want
state changes to be announced.
swup.announce?.(`Filtered by ${myFilterString}`);
swup.announce?.(`Filtered by ${myFilterString}`);