API: Core
calculatePosition
Function reference for calculatePosition.
Overview
- Kind: Function
- Source: packages/core/src/overlay/overlay-position.ts:109
Signature
function calculatePosition(anchorRect: DOMRect, overlayEl: HTMLElement, placement: OverlayPlacement, offset: number, flip: boolean, flipAxis?: OverlayFlipAxis, viewport?: { width: number; height: number; }, direction?: Direction): OverlayPosition
| Parameter | Type | Optional | Description |
|---|---|---|---|
anchorRect |
DOMRect |
||
overlayEl |
HTMLElement |
||
placement |
OverlayPlacement |
||
offset |
number |
||
flip |
boolean |
||
flipAxis |
OverlayFlipAxis |
Yes | |
viewport |
{ width: number; height: number } |
Yes | |
direction |
Direction |
Yes |
Returns OverlayPosition