Portal

Portal displays content in outside of the DOM hierarchy.

1
import { Portal } from '@cerberus/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:

Name	Default	Description
container	`document.body`	The mounted element to place the children contents within.
disabled	`false`	Disables the portal from rendering. Perfect for when you need to disabled a child Portal that is rendered within another Portal.

1
import { Portal } from '@cerberus/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:

Name	Default	Description
container	`document.body`	The mounted element to place the children contents within.
disabled	`false`	Disables the portal from rendering. Perfect for when you need to disabled a child Portal that is rendered within another Portal.