1. framework components
  2. portal

Portal

Renders children into a DOM node that exists outside the DOM hierarchy.

How It Works

When enabled, the content will move from the source to the target element.

API Reference

Root

PropDefaultType
disabledfalseboolean | undefined

If true, the portal functionality is disabled and children are rendered in place.

targetdocument.bodyHTMLElement | undefined

The HTML element to which the portal content will be appended.

childrenstring | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<...> | null

View page on GitHub