Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalProps

Hierarchy

  • PortalProps

Index

Properties

Properties

Optional children

children: ReactNode

The children to render within the portal.

Optional into

Either a function that returns an HTMLElement, an HTMLElement, or a document.querySelector string that will return the HTMLElement to render the children into. If both the into and intoId props are undefined, the document.body will be chosen instead.

If the querySelector string does not return a valid HTMLElement, an error will be thrown.

Optional intoId

intoId: string

The id of an element that the portal should be rendered into. If an element with the provided id can not be found on the page at the time of mounting, an error will be thrown.

Generated using TypeDoc