Skip to main content

Theme

Mode

Palettes

Accessibility

Portal API

Renderless teleport wrapper with automatic z-index stacking.

Explore these related pages for additional context and usage patterns.

Page	Category
Portal	Primitives
Dialog	Disclosure
Scrim	Providers
useStack	Plugins

Portal

Props

to

any

Teleport target. 'top-layer' mounts into the topmost open modal.

disabled

boolean | undefined

Render inline instead of teleporting.

Default: false

blocking

boolean | undefined

Block scrim close.

Default: false

scrim

boolean | undefined

Whether a scrim/backdrop should back this portal.

Default: true

promote

number | boolean | undefined

Keep this portal above overlays that open later. A number is the raise order when several promoted portals are open (higher paints on top). true is order 0.

Default: false

Events

close

[]

Slots

default

PortalSlotProps

Was this page helpful?