# Focus Trap

URL: https://ark-ui.com/docs/utilities/focus-trap
Source: https://raw.githubusercontent.com/chakra-ui/ark/refs/heads/main/website/src/content/pages/utilities/focus-trap.mdx

Trap focus within a specified container.

---

## Motivation

Focus trapping is essential for modal interfaces and other interactive elements that require user attention.

The `FocusTrap` component helps maintain accessibility by ensuring keyboard focus remains within a designated container
until explicitly released.

## Examples

**Example: basic**

```ripple
import { FocusTrap } from 'ark-ripple/focus-trap';
import { track } from 'ripple';

export component Basic() {
  let disabled = track(true);

  <div class="stack">
    <button
      type="button"
      onClick={() => {
        @disabled = false;
      }}
    >
      {'Start Trap'}
    </button>
    <FocusTrap returnFocusOnDeactivate={false} {disabled}>
      <div class="stack">
        <input type="text" placeholder="input" />
        <textarea placeholder="textarea" />
        <button
          type="button"
          onClick={() => {
            @disabled = true;
          }}
        >
          {'End Trap'}
        </button>
      </div>
    </FocusTrap>
  </div>
}

```

### Autofocus

The focus trap respects elements with the `autofocus` attribute.

**Example: autofocus**

```ripple
import { FocusTrap } from 'ark-ripple/focus-trap';
import { track } from 'ripple';

export component Autofocus() {
  let disabled = track(true);
  let buttonRef = track<HTMLButtonElement | null>(null);

  const getButtonNode = () => {
    const node = @buttonRef;
    if (!node) throw new Error('Button not found');
    return node;
  };

  <div class="stack">
    <button
      type="button"
      onClick={() => {
        @disabled = !@disabled;
      }}
      {ref (el: HTMLButtonElement | null) => {
        @buttonRef = el;
      }}
    >
      {@disabled ? 'Start Trap' : 'End Trap'}
    </button>
    if (@disabled) {
      <FocusTrap {disabled} setReturnFocus={getButtonNode}>
        <div class="stack">
          <input type="text" placeholder="Regular input" />
          <input type="text" placeholder="Autofocused input" autofocus />
          <button
            type="button"
            onClick={() => {
              @disabled = true;
            }}
          >
            {'End Trap'}
          </button>
        </div>
      </FocusTrap>
    }
  </div>
}

```

### Initial Focus

Use the `initialFocus` prop to set the element that should receive initial focus when the trap is activated.

**Example: initial-focus**

```ripple
import { FocusTrap } from 'ark-ripple/focus-trap';
import { track } from 'ripple';

export component InitialFocus() {
  let disabled = track(true);
  let inputRef = track<HTMLInputElement | null>(null);

  <div class="stack">
    <button
      type="button"
      onClick={() => {
        @disabled = !@disabled;
      }}
    >
      {@disabled ? 'Start Trap' : 'End Trap'}
    </button>
    <FocusTrap {disabled} initialFocus={() => @inputRef}>
      <div class="stack">
        <input type="text" placeholder="First input" />
        <input
          type="text"
          placeholder="Second input (initial focus)"
          {ref (el: HTMLInputElement | null) => {
            @inputRef = el;
          }}
        />
        <textarea placeholder="textarea" />
        <button
          type="button"
          onClick={() => {
            @disabled = true;
          }}
        >
          {'End Trap'}
        </button>
      </div>
    </FocusTrap>
  </div>
}

```

## API Reference

**Component API Reference**

**FocusTrap Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |
| `disabled` | `boolean` | No | Whether the focus trap is disabled. |
| `fallbackFocus` | `FocusTarget` | No | By default, an error will be thrown if the focus trap contains no
elements in its tab order. With this option you can specify a
fallback element to programmatically receive focus if no other
tabbable elements are found. For example, you may want a popover's
`<div>` to receive focus if the popover's content includes no
tabbable elements. *Make sure the fallback element has a negative
`tabindex` so it can be programmatically focused.

NOTE: If `initialFocus` is `false` (or a function that returns `false`),
this function will not be called when the trap is activated, and no element
will be initially focused. This function may still be called while the trap
is active if things change such that there are no longer any tabbable nodes
in the trap. |
| `initialFocus` | `VoidFunction | FocusTargetOrFalse` | No | By default, when a focus trap is activated the first element in the
focus trap's tab order will receive focus. With this option you can
specify a different element to receive that initial focus, or use `false`
for no initially focused element at all.

NOTE: Setting this option to `false` (or a function that returns `false`)
will prevent the `fallbackFocus` option from being used.

Setting this option to `undefined` (or a function that returns `undefined`)
will result in the default behavior. |
| `onActivate` | `VoidFunction` | No | A function that will be called **before** sending focus to the
target element upon activation. |
| `onDeactivate` | `VoidFunction` | No | A function that will be called **before** sending focus to the
trigger element upon deactivation. |
| `returnFocusOnDeactivate` | `boolean` | No | Default: `true`. If `false`, when the trap is deactivated,
focus will *not* return to the element that had focus before activation. |
| `setReturnFocus` | `type ONLY_FOR_FORMAT =
  | FocusTargetValueOrFalse
  | ((nodeFocusedBeforeActivation: HTMLElement | SVGElement) => FocusTargetValueOrFalse)` | No | By default, focus trap on deactivation will return to the element
that was focused before activation. |
