🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

react-trap-focus

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
r

react-trap-focus

A react component to trap focus for accessibility

1.0.3
latest
68

Supply Chain Security

100

Vulnerability

87

Quality

76

Maintenance

100

License

Unpopular package

Quality

This package is not very popular.

Found 1 instance in 1 package

Dependencies have 1 high alert.

Socket optimized override available

Version published
Weekly downloads
18
125%
Maintainers
1
Weekly downloads
 
Created
Issues
0

React Focus Trap npm

A react component to trap your focus for keyboard events.

It is as simple as wrapping your component with the FocusTrap and rest will be be taken care of.

Installation

Using npm:

$ npm i react-trap-focus

Using yarn:

$ yarn add react-trap-focus

Usage

There are 2 ways in which you can use it.

1) Wrapping any component in it.

The default query selector is [role="button"] but you can pass whatever your application sees fit.

import { FocusTrap } from 'react-trap-focus'

<FocusTrap>
    <Modal.Body>
        // Do Something
    </Modal.Body>
</FocusTrap>
import { FocusTrap } from 'react-trap-focus'

<FocusTrap querySelector={'div.highlighted > p'}>
 // Do something / wrap any component
</FocusTrap>

2) Directly calling the method on keyboard events.

The package also exposes focusTrap = (event: KeyboardEvent, elements: HTMLElement[]) function which can be used directly on keyboard events.

Pass the event and the elements list you want to be focus trapped.

import { focusTrap } from 'react-trap-focus'

  const allButtonEls = document.querySelectorAll('[role="button"]')
  const onKeyDown = event => focusTrap(event, allButtonEls)
  return (
    <div onKeyDown={onKeyDown}>
      // Do something
    </div>
  )

FAQs

Package last updated on 13 Jun 2022

Did you know?

Socket

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