Skip to content

1681-engine / ui / TooltipOptions

Interface: TooltipOptions ​

Defined in: src/ui/layout/placeTooltip.ts:5

Properties ​

align? ​

ts
optional align?: "center" | "start";

Defined in: src/ui/layout/placeTooltip.ts:13

Across the side: line up with the anchor's start or centre on it (default 'start').


gap? ​

ts
optional gap?: number;

Defined in: src/ui/layout/placeTooltip.ts:9

Between the anchor and the tip (default 4).


margin? ​

ts
optional margin?: number;

Defined in: src/ui/layout/placeTooltip.ts:11

Kept clear of the screen's edges (default 4).


side? ​

ts
optional side?: TipSide;

Defined in: src/ui/layout/placeTooltip.ts:7

The side tried first (default 'below'); the opposite one when it does not fit.


snap? ​

ts
optional snap?: boolean;

Defined in: src/ui/layout/placeTooltip.ts:14

Released under the MIT License.