FloatingPortal

Portals the floating element into a given container element — by default, outside of the app root and into the body.

import {FloatingPortal} from '@floating-ui/react';
 
function Tooltip() {
  return (
    isOpen && (
      <FloatingPortal>
        <div>Floating element</div>
      </FloatingPortal>
    )
  );
}

import {FloatingPortal} from '@floating-ui/react';
 
function Tooltip() {
  return (
    isOpen && (
      <FloatingPortal>
        <div>Floating element</div>
      </FloatingPortal>
    )
  );
}

Context is provided so that portals nested in one another are appended to their respective parent.

Props

interface Props {
  root?:
    | HTMLElement
    | null
    | React.MutableRefObject<HTMLElement | null>;
  id?: string;
  preserveTabOrder?: boolean;
}

interface Props {
  root?:
    | HTMLElement
    | null
    | React.MutableRefObject<HTMLElement | null>;
  id?: string;
  preserveTabOrder?: boolean;
}

root

Optionally specifies the root node the portal container will be appended to.

// Element
<FloatingPortal root={rootNode} />
// MutableRefObject
<FloatingPortal root={rootNodeRef} />

// Element
<FloatingPortal root={rootNode} />
// MutableRefObject
<FloatingPortal root={rootNodeRef} />

id

Optionally selects the node with the id if it exists, or create it and append it to the specified root (by default document.bodydocument.body).

<FloatingPortal id="custom-root-id" />

<FloatingPortal id="custom-root-id" />

preserveTabOrder

default: truetrue

When using non-modal focus management using <FloatingFocusManager /><FloatingFocusManager />, this will preserve the tab order context based on the React tree instead of the DOM tree.

<FloatingPortal preserveTabOrder={false} />

<FloatingPortal preserveTabOrder={false} />

`useFloatingPortalNode`

Exposes the portal container node for custom use in other components.

function App() {
  const portalNode = useFloatingPortalNode({
    // Accepts `id` and `root` props
  });
 
  if (portalNode) {
    return createPortal(<div />, portalNode);
  }
 
  return null;
}

function App() {
  const portalNode = useFloatingPortalNode({
    // Accepts `id` and `root` props
  });
 
  if (portalNode) {
    return createPortal(<div />, portalNode);
  }
 
  return null;
}