Parameters

Name	Type	Default	Description
mode	'context' | 'fixed'	required	Positioning strategy: context follows an anchor element, fixed uses explicit x / y coordinates.
anchor	Ref<HTMLElement | null>	—	External anchor element for context mode. Leave it out and bind the returned anchorRef to the trigger instead.
placement	'above' | 'below' | 'start' | 'end' | MaybeRefOrGetter	'below'	Side of the anchor the layer is placed on. Logical: start / end mirror under RTL. Flips when there is no room.
alignment	'start' | 'center' | 'end' | MaybeRefOrGetter	'center'	Alignment along the placement axis.
gap	number	4	Clearance between the anchor and the layer, in pixels.
x	number | MaybeRefOrGetter	0	Horizontal viewport coordinate for fixed mode.
y	number | MaybeRefOrGetter	0	Vertical viewport coordinate for fixed mode.
isDefaultOpen	boolean	false	Whether the layer is open on the first render.
lightDismiss	boolean | MaybeRefOrGetter	false	Whether clicking outside dismisses the layer.
lazyMount	boolean | MaybeRefOrGetter	false	Whether to wait for the first show() before rendering the content. isMounted reports the answer.
onShow	() => void	—	Called when show() opens the layer. Opening through isDefaultOpen is not a show, so it does not fire.
onHide	() => void	—	Called when hide() closes the layer.

Returns

Field	Type	Description
isOpen	ShallowRef<boolean>	Whether the layer is currently open.
anchorRef	Ref<HTMLElement | null>	Anchor element for context mode. Bind it with :ref; unset in fixed mode.
contentRef	Ref<HTMLElement | null>	Layer container. Measured for positioning and used for outside clicks.
contentStyle	ComputedRef<CSSProperties>	Inline coordinates: measured top / left in context mode, position: fixed plus x / y in fixed mode.
resolvedPlacement	ComputedRef<'above' | 'below' | 'start' | 'end'>	Placement actually in effect after flipping for available space. Equal to the requested placement in fixed mode.
isMounted	ComputedRef<boolean>	Whether the content should render. Stays false until the first show() while lazyMount is on.
id	string	Unique ID for aria-controls or aria-describedby.
anchorId	string	CSS identifier for the anchor element, for advanced positioning cases.
show	() => void	Imperatively show the layer.
hide	() => void	Imperatively hide the layer.