The content or node you'll like to portal
Portal
Renders a component outside the current DOM hierarchy.
Props#
childrenrequired
childrenrequiredDescription
Type
ReactNodeappendToParentPortal
appendToParentPortalDescription
If true, the portal will check if it is within a parent portal
and append itself to the parent's portal node.
This provides nesting for portals.
If false, the portal will always append to `document.body`
regardless of nesting. It is used to opt out of portal nesting.
Type
booleanDefault
truecontainerRef
containerRefDescription
The ref to the component where the portal will be attached to.
Type
RefObject<HTMLElement | null>Props#
childrenrequired
childrenrequiredDescription
The content or node you'll like to portal
Type
ReactNodeappendToParentPortal
appendToParentPortalDescription
If true, the portal will check if it is within a parent portal
and append itself to the parent's portal node.
This provides nesting for portals.
If false, the portal will always append to `document.body`
regardless of nesting. It is used to opt out of portal nesting.
Type
booleanDefault
truecontainerRef
containerRefDescription
The ref to the component where the portal will be attached to.
Type
RefObject<HTMLElement | null>