FocusTrap API

API reference docs for the React FocusTrap component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import FocusTrap from '@mui/base/FocusTrap';
// or
import { FocusTrap } from '@mui/base';

Utility component that locks focus inside the component.

Name	Type	Default	Description
open^*	bool		If `true`, focus is locked.
children	element		A single child content element. ⚠️ Needs to be able to hold a ref.
disableAutoFocus	bool	false	If `true`, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the `disableAutoFocus` prop. Generally this should never be set to `true` as it makes the focus trap less accessible to assistive technologies, like screen readers.
disableEnforceFocus	bool	false	If `true`, the focus trap will not prevent focus from leaving the focus trap while open. Generally this should never be set to `true` as it makes the focus trap less accessible to assistive technologies, like screen readers.
disableRestoreFocus	bool	false	If `true`, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.
getTabbable	func		Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency. Signature: `function(root: HTMLElement) => void`
isEnabled	func	function defaultIsEnabled(): boolean { return true; }	This prop extends the `open` prop. It allows to toggle the open state without having to wait for a rerender when changing the `open` prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time.

The component cannot hold a ref.