API: Core
OverlayArrowGeometry
Geometry for a consumer-rendered arrow.
Overview
Geometry for a consumer-rendered arrow. Quartz computes numbers only — no markup, colors or dimensions. All values describe the surface after flip, alignment changes and viewport clamping, so they never refer to the requested placement.
- Kind: Interface
- Source: packages/core/src/overlay/overlay-arrow.ts:18
Declaration
interface OverlayArrowGeometry
Properties
| Name | Type | Description |
|---|---|---|
placement |
OverlayPlacement |
Resolved (physical) placement after flip. -start/-end are physical, also in RTL. |
side |
OverlaySide |
Side of the anchor the surface sits on (top placement → top). Same as Radix data-side. |
edge |
OverlaySide |
Edge of the surface that faces the anchor and carries the arrow (top placement → bottom). |
alignment |
'start' | 'center' | 'end' |
Where the resolved placement aligns the surface to the anchor. |
axis |
'x' | 'y' |
Axis the offsets run along: x for top/bottom placements, y for left/right. |
offset |
number | null |
Px from the surface's start edge (left for x, top for y) to the arrow's start edge, i.e. the value to bind to left/top. null when available is false. |
centerOffset |
number | null |
Px from the surface's cross-axis center to the arrow's center. null when unavailable. |
available |
boolean |
false when no safe arrow position exists: the arrow (plus padding) does not fit the surface edge, the anchor does not overlap the surface along the cross axis, or a measurement is not finite. Consumers should hide the arrow. Offsets are null then — never NaN or Infinity. |