mmr-gl-react
Version:
React components for MMR GL JS-compatible libraries
24 lines (23 loc) • 1.3 kB
TypeScript
import * as React from 'react';
import { MmrProps } from '../mmr/mmr';
import { MapRef } from '../mmr/create-ref';
import type { CSSProperties } from 'react';
import { GlobalSettings } from '../utils/set-globals';
import type { MapLib, MapInstance, MapStyle, Callbacks } from '../types';
export type MapContextValue<MapT extends MapInstance = MapInstance> = {
mapLib: MapLib<MapT>;
map: MapRef<MapT>;
};
export declare const MapContext: React.Context<MapContextValue<MapInstance>>;
type MapInitOptions<MapOptions> = Omit<MapOptions, 'style' | 'container' | 'bounds' | 'fitBoundsOptions' | 'center'>;
export type MapProps<MapOptions, StyleT extends MapStyle, CallbacksT extends Callbacks, MapT extends MapInstance> = MapInitOptions<MapOptions> & MmrProps<StyleT, CallbacksT> & GlobalSettings & {
mapLib?: MapLib<MapT> | Promise<MapLib<MapT>>;
reuseMaps?: boolean;
/** Map container id */
id?: string;
/** Map container CSS style */
style?: CSSProperties;
children?: any;
};
export default function Map<MapOptions, StyleT extends MapStyle, CallbacksT extends Callbacks, MapT extends MapInstance>(props: MapProps<MapOptions, StyleT, CallbacksT, MapT>, ref: React.Ref<MapRef<MapT>>, defaultLib: MapLib<MapT> | Promise<MapLib<MapT>>): React.JSX.Element;
export {};