Home > @magiclane/maps-sdk > PopupOptions

PopupOptions interface

Options for popups opened with GemMap.showPopup().

Signature:

export interface PopupOptions 

Properties

Property

Modifiers

Type

Description

anchor?

'center' | 'top' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'

(Optional) Which side of the coordinate the popup sits on. Default: 'bottom' edge of the popup points at the coordinate (popup above it).

className?

string

(Optional) Extra class name on the popup container (styling hook).

closeButton?

boolean

(Optional) Render an × close button. Default true.

closeOnClick?

boolean

(Optional) Clicking the map closes the popup. Default true.

maxWidth?

string

(Optional) CSS max-width of the popup body. Default '260px'.

offset?

number

(Optional) Pixels between the coordinate and the popup. Default 0.