dropdown

Traps focus for accessible dropdowns and modal content

Oct 13, 2018
Traps focus for accessible dropdowns and modal content

react-focus-trap

A generic focus management tool for components such as dialogs and dropdowns.

Usage

React Focus Trap is a container element that will manage focus for its children.

let Modal = React.createClass({ render() { return ( <FocusTrap onExit={ this._onExit } active={ this.props.active }> Amazing stuff goes here </FocusTrap> ) } })

When Focus Trap is active, it will do several things:

  1. Ensure focus remains on its content
  2. Exits when clicks outside of the container occur
  3. Exits when the escape key is pressed

Props

NameDefaultDescription
activetrueShould the FocusTrap render?
className'focus-trap'The class of the inner container that maintains focus
onExitnullCallback when escape or an outside click occurs
element'div'The tag name of the inner container
role'dialog'The aria role for the inner container

GitHub

Recommended