Oaf Angular Router
An accessible wrapper for Angular's Router.
Documentation at https://oaf-project.github.io/oaf-angular-router/
Features
- Reset scroll and focus after page 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, with the caveat that Oaf Angular Router doesn't currently support focus and scroll restoration after POP navigation (see issue #3).
Installation
# yarn yarn add oaf-angular-router # npm npm install oaf-angular-router
Basic Usage
app.module.ts
:
- import { Router } from '@angular/router';+ import { Event, Router, NavigationEnd } from '@angular/router';+ import { wrapRouter } from "oaf-angular-router"; export class AppModule { constructor(router: Router) {+ // HACK instanceof doesn't work across require() boundary+ const isNavigationEndEvent = (event: Event) => event instanceof NavigationEnd;+ wrapRouter(router, isNavigationEndEvent); }}
Advanced Usage
; wrapRouterrouter, isNavigationEndEvent, settings;
A note on focus outlines
You may see focus outlines around your h1
elements (or elsewhere, per primaryFocusTarget
) when using Oaf Angular Router.
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.