FocusTrapRegion

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

Code examples

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

Optional Props

`enabled`

boolean | undefined = false
boolean | undefined = false

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

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, 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.

Some Ariakit components detect the type of the underlying element when they mount. If the render element's type may change while the component is mounted, pass a key⁠ prop that changes with the element type so React remounts the component with the new element. Remounting resets uncontrolled state, so keep the relevant state controlled:

<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>
<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>

Check out the Composition guide for more details.

FocusTrapRegion

Code examples

Optional Props

enabled

render

Stay tuned

`enabled`

`render`