Skip to content
Add focus traps around elements.
Branch: master
Clone or download
Latest commit 6393e72 Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dest
src Fix test command Nov 9, 2018
.babelrc
.flowconfig
.gitignore readme updates Nov 9, 2018
.prettierrc init Nov 9, 2018
.travis.yml init Nov 9, 2018
package.json
readme.md Readme update Nov 9, 2018
yarn.lock init Nov 9, 2018

readme.md

focus-trap

Add focus traps around elements.

Adding a focus traps is important part of making your site accessible. The most common example where you want to set up a focus trap is a modal. While modal is open, the user shouldn't be able to tab outside of it, and focus should be locked within the modal elements. You have to remember to make sure there is always a way how to exit this focus trap. In modal example it's usually the escape key, or close button in the corner.

Demo

Install

Using npm

npm install @daniel.husar/focus-trap

Using yarn

yarn add @daniel.husar/focus-trap

Usage

import FocusTrap from '@daniel.husar/focus-trap';
// Setup trap
const trap = new FocusTrap({ node: document.querySelector('#my-trap') });
// Release trap
trap.restore();

Constructor API

Constructor accept object with those properties:

new FocusTrap({
  node: document.querySelector('#my-trap') }),
  firstElement: () => document.querySelector('#first-element'),
  lastElement: () => document.querySelector('#last-element'),
  disableStartingTrap: () => false,
  disableEndingTrap: () => false,
});

node

Type: DOM element

Default: none

Required: true

This is the DOM node you want to set-up focus trap around

firstElement

Type: Function

Default: () => null

Required: none

Function that returns element that will replace first element when focus will jump back at the start. Usefull when you want to connect 2 focus traps together. Will fallback to firstElement in focus trap if function returns falsy value.

lastElement

Type: Function

Default: () => null

Required: none

Function that returns element that will replace last element when focus will jump back at the end. Usefull when you want to connect 2 focus traps together. Will fallback to lastElement in focus trap if function returns falsy value.

disableStartingTrap

Type: Function

Default: () => false

Required: none

Function that returns boolean if the starting trap should be disabled.

disableEndingTrap

Type: Function

Default: () => false

Required: none

Function that can returns boolean if the ending trap should be disabled.

Interface

recalculateFocusableElements

Type: Function

Recalculate focusable elements inside of your trap. Usefull if content of the node changes over time.

restore

Type: Function

Remove the focus trap from element.

License

MIT © Daniel Husar

You can’t perform that action at this time.