Oaf Svelte Routing
An accessible wrapper for Svelte Routing.
Documentation at https://oaf-project.github.io/oaf-svelte-routing/
Features
- Reset scroll and focus after PUSH and REPLACE navigation
- Restore scroll and focus after POP navigation
- Set the page title after navigation
- Announce navigation to users of screen readers
- Hash fragment support
In lieu of more details, see Oaf React Router for now. The features are basically the same.
Installation
# yarn yarn add oaf-svelte-routing # npm npm install oaf-svelte-routing
Basic Usage
main.js
:
import App from "./App.svelte";+ import { globalHistory as history } from "svelte-routing/src/history";+ import { wrapHistory } from "oaf-svelte-routing"; + wrapHistory(history); new App({ target: document.getElementById("app"), hydrate: true});
Advanced Usage
const settings = announcementsDivId: "announcements" primaryFocusTarget: "main h1, [role=main] h1" // This assumes you're setting the document title via some other means. // If you're not, you should return a unique and descriptive page title for each page // from this function and set `setPageTitle` to true. documenttitle // BYO localization `Navigated to .` true announcePageNavigation: true setPageTitle: false handleHashFragment: true // Set this to true for smooth scrolling. // For browser compatibility you might want iamdustan's smoothscroll polyfill https://github.com/iamdustan/smoothscroll smoothScroll: false; ;
A note on focus outlines
You may see focus outlines around your h1
elements (or elsewhere, per primaryFocusTarget
) when using Oaf Svelte Routing.
You might be tempted to remove these focus outlines with something like the following:
[
Don't do this! Focus outlines are important for accessibility. See for example:
- https://www.w3.org/TR/UNDERSTANDING-WCAG20/navigation-mechanisms-focus-visible.html
- https://www.w3.org/TR/2016/NOTE-WCAG20-TECHS-20161007/F78
- http://www.outlinenone.com/
Note that Bootstrap 4 unfortunately removes these focus outlines. If you use Bootstrap, you can restore them with Oaf Bootstrap 4.
All that said, if you absolutely must remove focus outlines (stubborn client, stubborn boss, stubborn designer, whatever), consider using the :focus-visible
polyfill so focus outlines are only hidden from mouse users, not keyboard users.