Renders a wrapper element that traps the focus inside it when the enabled prop is true.

Code examples

<Button>click me</Button>
<Button>trap focus</Button>
<Button disabled>disabled Button</Button>

Optional Props


boolean | undefined = false

If true, it will trap the focus in the region.


RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged.

Check out the Composition guide for more details.

Stay tuned

Join 1,000+ subscribers and receive monthly tips & updates on new Ariakit content.

No spam. Unsubscribe anytime. Read latest issue