Socket
Socket
Sign inDemoInstall

react-focus-trap

Package Overview
Dependencies
0
Maintainers
1
Versions
36
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-focus-trap

Traps focus for accessible dropdowns and modal content.


Version published
Weekly downloads
9.1K
decreased by-37.6%
Maintainers
1
Install size
15.3 kB
Created
Weekly downloads
 

Changelog

Source

2.7.2

  • Use index.js for main, fix "Invalid 'main' field" deprecation notice.

Readme

Source

NPM


Circle CI


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

focus

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

Code At Viget

Visit code.viget.com to see more projects from Viget.

Keywords

FAQs

Last updated on 23 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc