Portal

Portal displays content in outside of the DOM hierarchy.

import { Portal } from '@cerberus-design/react'

Usage

API

export interface PortalProps {
container?: RefObject<HTMLElement>;
disabled?: boolean;
}
define function Portal(props: PropsWithChildren<PortalProps>): ReactPortal | null

Props

The Portal component accepts the following props:

NameDefaultDescription
containerdocument.bodyThe mounted element to place the children contents within.
disabledfalseDisables the portal from rendering. Perfect for when you need to disabled a child Portal that is rendered within another Portal.

On this page