Vizel API / core/src / VizelPopoverControllerOptions

Interface: VizelPopoverControllerOptions

Defined in: packages/core/src/controllers/popoverController.ts:27

Options for createVizelPopoverController.

Properties

dismissOnEscape?

optional dismissOnEscape?: boolean;

Defined in: packages/core/src/controllers/popoverController.ts:39

Whether Escape dismisses (default: true).

---

getAnchor

getAnchor: () => HTMLElement | null;

Defined in: packages/core/src/controllers/popoverController.ts:29

Returns the anchor element the body positions against.

Returns

HTMLElement | null

---

getBody

getBody: () => HTMLElement | null;

Defined in: packages/core/src/controllers/popoverController.ts:31

Returns the floating body element to position.

Returns

HTMLElement | null

---

offset?

optional offset?: number;

Defined in: packages/core/src/controllers/popoverController.ts:35

Pixel offset between the anchor and the body. Defaults to 4.

---

onDismiss

onDismiss: () => void;

Defined in: packages/core/src/controllers/popoverController.ts:37

Called when the controller decides the popover should close.

Returns

void

---

placement?

optional placement?: VizelPopoverPlacement;

Defined in: packages/core/src/controllers/popoverController.ts:33

Preferred placement; defaults to "bottom-start".

---

repositionOnWindowEvents?

optional repositionOnWindowEvents?: boolean;

Defined in: packages/core/src/controllers/popoverController.ts:45

Whether window resize and scroll events trigger a reposition. Defaults to true. Set to false for popovers anchored to fixed elements that do not move.