Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
@charlietango/use-focus-trap
Advanced tools
Trap keyboard focus inside a DOM element, to prevent the user navigating outside a modal
Trap keyboard focus inside a DOM element, to prevent the user navigating outside a modal.
When using this, make sure to combine it with a fixed position <Backdrop>
that prevents the mouse from clicking input elements.
Checkout the Storybook demo.
yarn add @charlietango/use-focus-trap
const ref = useFocusTrap(active, options)
import React from 'react'
import useFocusTrap from '@charlietango/use-focus-trap'
const Component = () => {
const ref = useFocusTrap()
return (
<div ref={ref}>
<button>Trapped to the button</button>
</div>
)
}
export default Component
When using this inside to create a Modal, there are a few things you need to handle:
aria-hidden
on rootThis is the base component for creating a <Modal />
. It receives an onRequestClose
method,
that can be triggered to tell the containing component to update it's state to close the modal.
It doesn't contain a <Backdrop />
, but that would be a absolute positioned component, that
when clicked triggers the onRequestClose
method.
import React, { useEffect } from 'react'
import ReactDOM from 'react-dom'
import useFocusTrap from '@charlietango/use-focus-trap'
import styled from 'styled-components'
type Props = {
onRequestClose?: () => void
children?: React.ReactNode
isOpen: boolean
className?: string
}
const Wrapper = styled.div`
position: fixed;
left: 0;
right: 0;
top: 0;
bottom: 0;
z-index: 5;
`
function updateHiddenRoot(hidden: boolean) {
// Make sure to find the actual root in your application
const root = document.getElementById('root')
if (hidden) {
if (root) root.setAttribute('aria-hidden', 'true')
} else {
if (root) root.removeAttribute('aria-hidden')
}
}
function BaseModal({ children, isOpen, onRequestClose, className }: Props) {
const ref = useFocusTrap()
function handleKeyDown(event: KeyboardEvent) {
if (event.key === 'Escape') {
if (onRequestClose) onRequestClose()
}
}
useEffect(() => {
updateHiddenRoot(isOpen)
if (isOpen) {
document.addEventListener('keydown', handleKeyDown)
return () => {
document.removeEventListener('keydown', handleKeyDown)
}
}
return
}, [isOpen])
const modal = (
<Wrapper
ref={ref}
style={{ pointerEvents: !isOpen ? 'none' : undefined }}
role="dialog"
className={className}
>
{children}
</Wrapper>
)
return ReactDOM.createPortal(modal, window.document.body)
}
BaseModal.displayName = 'BaseModal'
BaseModal.defaultProps = {}
export default BaseModal
FAQs
Trap keyboard focus inside a DOM element, to prevent the user navigating outside a modal
The npm package @charlietango/use-focus-trap receives a total of 3,846 weekly downloads. As such, @charlietango/use-focus-trap popularity was classified as popular.
We found that @charlietango/use-focus-trap demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
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.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.