Skip to content
This repository has been archived by the owner on Aug 29, 2021. It is now read-only.

Latest commit

 

History

History
101 lines (77 loc) · 4.46 KB

README.md

File metadata and controls

101 lines (77 loc) · 4.46 KB
Raw

Build Status Known Vulnerabilities Greenkeeper badge npm

dependencies Status devDependencies Status peerDependencies Status

Oaf Ember Routing

An accessible wrapper for Ember routing, built with Oaf Routing.

Documentation at https://oaf-project.github.io/oaf-ember-routing/

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 Ember Routing doesn't currently support focus and scroll restoration after POP navigation.

Installation

# yarn
yarn add oaf-ember-routing

# npm
npm install oaf-ember-routing

Basic Usage

import EmberRouter from '@ember/routing/router';
+ import { createOafEmberRouter } from 'oaf-ember-routing';

+ const oafRouter = createOafEmberRouter();

const Router = EmberRouter.extend({
  ... 
  init() {
    this._super(...arguments);
    ...
+    this.on('routeDidChange', oafRouter.routeDidChange);
  }
});

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: (location: Navigation) => document.title,
  // BYO localization
  navigationMessage: (title: string, location: Navigation): string => `Navigated to ${title}.`,
  shouldHandleAction: (previousLocation: Navigation, nextLocation: Navigation) => true,
  announcePageNavigation: true,
  setPageTitle: false,
  // Set this to true for smooth scrolling.
  // For browser compatibility you might want iamdustan's smoothscroll polyfill https://github.com/iamdustan/smoothscroll
  smoothScroll: false,
};

const oafRouter = createOafEmberRouter(settings);

A note on focus outlines

You may see focus outlines around your h1 elements (or elsewhere, per primaryFocusTarget) when using Oaf Ember Routing.

You might be tempted to remove these focus outlines with something like the following:

[tabindex="-1"]:focus {
  outline: 0 !important;
}

Don't do this! Focus outlines are important for accessibility. See for example:

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.

See also