Trap focus within a DOM node.
There may come a time when you find it important to trap focus within a DOM node — so that when a user hits Tab or Shift+Tab or clicks around, she can't escape a certain cycle of focusable elements.
You will definitely face this challenge when you are try to build accessible modals or dropdown menus.
This module is a little vanilla JS solution to that problem.
If you are using React, check out focus-trap-react, a light wrapper around this library. If you are not a React user, consider creating light wrappers in your framework-of-choice!
When a focus trap is activated, this is what should happen:
- Some element within the focus trap receives focus. By default, this will be the first element in the focus trap's tab order (as determined by tabbable). Alternately, you can specify an element that should receive this initial focus.
- The
TabandShift+Tabkeys will cycle through the focus trap's tabbable elements but will not leave the focus trap. - Clicks within the focus trap behave normally; but clicks outside the focus trap are blocked.
- The
Escapekey will deactivate the focus trap.
When the focus trap is deactivated, this is what should happen:
- Focus is passed to whichever element had focus when the trap was activated (e.g. the button that opened the modal or menu).
- Tabbing and clicking behave normally everywhere.
For more advanced usage (e.g. focus traps within focus traps), you can also pause a focus trap's behavior without deactivating it entirely, then unpause at will.
npm install focus-trap
You can also use a UMD version published to unpkg.com as dist/focus-trap.js and dist/focus-trap.min.js.
IE9+
Why?
Because this module uses EventTarget.addEventListener().
And its only dependency, tabbable, uses a couple of IE9+ functions.
Returns a new focus trap on element.
element can be
- a DOM node (the focus trap itself) or
- a selector string (which will be pass to
document.querySelector()to find the DOM node).
createOptions:
- onActivate {function}: A function that will be called when the focus trap activates.
- onDeactivate {function}: A function that will be called when the focus trap deactivates,
- initialFocus {element|string|function}: By default, when a focus trap is activated the first element in the focus trap's tab order will receive focus. With this option you can specify a different element to receive that initial focus. Can be a DOM node, or a selector string (which will be passed to
document.querySelector()to find the DOM node), or a function that returns a DOM node. - fallbackFocus {element|string|function}: By default, an error will be thrown if the focus trap contains no elements in its tab order. With this option you can specify a fallback element to programmatically receive focus if no other tabbable elements are found. For example, you may want a popover's
<div>to receive focus if the popover's content includes no tabbable elements. Make sure the fallback element has a negativetabindexso it can be programmatically focused. The option value can be a DOM node, a selector string (which will be passed todocument.querySelector()to find the DOM node), or a function that returns a DOM node. - escapeDeactivates {boolean}: Default:
true. Iffalse, theEscapekey will not trigger deactivation of the focus trap. This can be useful if you want to force the user to make a decision instead of allowing an easy way out. - clickOutsideDeactivates {boolean}: Default:
false. Iftrue, a click outside the focus trap will deactivate the focus trap and allow the click event to do its thing. - returnFocusOnDeactivate {boolean}: Default:
true. Iffalse, when the trap is deactivated, focus will not return to the element that had focus before activation.
Activates the focus trap, adding various event listeners to the document.
If focus is already within it the trap, it remains unaffected. Otherwise, focus-trap will try to focus the following nodes, in order:
createOptions.initialFocus- The first tabbable node in the trap
createOptions.fallbackFocus
If none of the above exist, an error will be thrown. You cannot have a focus trap that lacks focus.
Returns the focusTrap.
activateOptions:
These options are used to override the focus trap's default behavior for this particular activation.
- onActivate {function | null | false}: Default: whatever you chose for
createOptions.onActivate.nullorfalseare the equivalent of anoop.
Deactivates the focus trap.
Returns the focusTrap.
deactivateOptions:
These options are used to override the focus trap's default behavior for this particular deactivation.
- returnFocus {boolean}: Default: whatever you chose for
createOptions.returnFocusOnDeactivate. - onDeactivate {function | null | false}: Default: whatever you chose for
createOptions.onDeactivate.nullorfalseare the equivalent of anoop.
Pause an active focus trap's event listening without deactivating the trap.
If the focus trap has not been activated, nothing happens.
Returns the focusTrap.
Any onDeactivate callback will not be called, and focus will not return to the element that was focused before the trap's activation. But the trap's behavior will be paused.
This is useful in various cases, one of which is when you want one focus trap within another. demo-six exemplifies how you can implement this.
Unpause an active focus trap. (See pause(), above.)
Focus is forced into the trap just as described for focusTrap.activate().
If the focus trap has not been activated or has not been paused, nothing happens.
Returns the focusTrap.
Read code in demo/ (it's very simple), and see how it works.
Here's what happens in demo-one.js:
var createFocusTrap = require('../../');
var containerOne = document.getElementById('demo-one');
var focusTrapOne = createFocusTrap('#demo-one', {
onDeactivate: function () {
containerOne.className = 'trap';
},
});
document.getElementById('activate-one').addEventListener('click', function () {
focusTrapOne.activate();
containerOne.className = 'trap is-active';
});
document.getElementById('deactivate-one').addEventListener('click', function () {
focusTrapOne.deactivate();
});- Only one focus trap can be listening at a time. So if you want two focus traps active at a time, one of them has to be paused.
Because of the nature of the functionality, involving keyboard and click and (especially) focus events, JavaScript unit tests didn't make sense. (If you disagree and can help out, please PR!) So the demo is also the test: run it in browsers and see how it works, checking the documented requirements.