Interface HonuaMapProps

Props for HonuaMap.

interface HonuaMapProps {
    children?: ReactNode;
    className?: string;
    loadOptions?: Omit<LoadMapPackageOptions, "client">;
    map?: MaplibreMap;
    mapLibre?: MapLibreGlModule;
    mapOptions?: Partial<Omit<MapLibreMapOptions, "container">>;
    onError?: ((error: unknown) => void);
    onRuntime?: ((runtime: HonuaMapRuntime) => void);
    package: HonuaMapPackage;
    style?: CSSProperties;
}

Properties

children? className? loadOptions? map? mapLibre? mapOptions? onError? onRuntime? package style?

Properties

Optionalchildren

children?: ReactNode

OptionalclassName

className?: string

OptionalloadOptions

loadOptions?: Omit<LoadMapPackageOptions, "client">

Extra options forwarded to loadMapPackage. client is taken from the provider; a popupFactory is defaulted from the maplibre module when one is available so HonuaPopup works out of the box.

Optionalmap

map?: MaplibreMap

Attach to an existing, externally-owned map instead of creating one. When set, HonuaMap never removes the map on unmount (the owner is responsible) — it only disposes the runtime.

OptionalmapLibre

mapLibre?: MapLibreGlModule

The maplibre-gl module. Provide it to avoid a dynamic import (and to pin the exact version). Ignored when map is supplied.

OptionalmapOptions

mapOptions?: Partial<Omit<MapLibreMapOptions, "container">>

Extra options merged into the maplibre-gl Map constructor when HonuaMap owns the map (container and style are managed for you).

OptionalonError

onError?: ((error: unknown) => void)

Called if map creation or package loading fails.

OptionalonRuntime

onRuntime?: ((runtime: HonuaMapRuntime) => void)

Called once the runtime is ready.

package

package: HonuaMapPackage

The MapPackage to compose onto the map.

Optionalstyle

style?: CSSProperties

Settings

Member Visibility

On This Page

Properties