OverlayConfig

Overview

• Kind: Interface
• Source: packages/core/src/overlay/overlay.types.ts:17

Declaration

interface OverlayConfig

Properties

Name	Type	Description
placement	OverlayPlacement	Placement relative to the anchor element. Default: 'bottom-start'
offset	number	Gap in px between anchor and overlay. Default: 4
flip	boolean	Whether to flip placement when there's not enough space. Default: true
flipAxis	OverlayFlipAxis	Which alternatives flip may try when the placement overflows the viewport. main: opposite side. cross: opposite alignment on the same side (-start ↔ -end). both: opposite side, then opposite alignment, then both. none: never flip. Default: 'main'
closeOnClickOutside	boolean	Close when user clicks outside the overlay. Default: true
closeOnEscape	boolean	Close on Escape key. Default: true
closeOnScroll	boolean	Close when the trigger's scroll parent scrolls. Default: true
matchAnchorWidth	boolean	Whether to match the anchor's width. Default: false

Related types

• OverlayFlipAxis
• OverlayPlacement