Portal

A wrapper for rendering components in React portals.

Installation

Package installation information
Installyarn add @atlaskit/portal
SourceBitbucket.org, (opens new window)
npm@atlaskit/portal, (opens new window)
Bundleunpkg.com, (opens new window)

Props

children

Required
Description
No description.
Typestring | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal

mountStrategy

Description

Specify the mount strategy: useEffect or useLayoutEffect. Note: UseLayoutEffect can lead to performance issues and is discouraged.

Default"effect"
Type"effect" | "layoutEffect"

zIndex

Description
No description.
Default0
Typestring | number
Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License