DefinitelyTyped/types/react-leaflet/index.d.ts

// Type definitions for react-leaflet 1.1
// Project: https://github.com/PaulLeCam/react-leaflet
// Definitions by: Dave Leaver <https://github.com/danzel>, David Schneider <https://github.com/davschne>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

import * as Leaflet from 'leaflet';
import * as React from 'react';

// All events need to be lowercase so they don't collide with React.DOMAttributes<T>
// which already declares things with some of the same names

type Children = React.ReactNode | React.ReactNode[];

interface LeafletLayerEvents {
    onbaselayerchange?(event: Leaflet.LayersControlEvent): void;
    onoverlayadd?(event: Leaflet.LayersControlEvent): void;
    onoverlayremove?(event: Leaflet.LayersControlEvent): void;
    onlayeradd?(event: Leaflet.LayerEvent): void;
    onlayerremove?(event: Leaflet.LayerEvent): void;
}
interface LeafletMapStateChangeEvents {
    onzoomlevelschange?(event: Leaflet.Event): void;
    onresize?(event: Leaflet.ResizeEvent): void;
    onunload?(event: Leaflet.Event): void;
    onviewreset?(event: Leaflet.Event): void;
    onload?(event: Leaflet.Event): void;
    onzoomstart?(event: Leaflet.Event): void;
    onmovestart?(event: Leaflet.Event): void;
    onzoom?(event: Leaflet.Event): void;
    onmove?(event: Leaflet.Event): void;
    onzoomend?(event: Leaflet.Event): void;
    onmoveend?(event: Leaflet.Event): void;
}
interface LeafletPopupEvents {
    onpopupopen?(event: Leaflet.PopupEvent): void;
    onpopupclose?(event: Leaflet.PopupEvent): void;
    onautopanstart?(event: Leaflet.Event): void;
}
interface LeafletTooltipEvents {
    ontooltipopen?(event: Leaflet.TooltipEvent): void;
    ontooltipclose?(event: Leaflet.TooltipEvent): void;
}
interface LeafletLocationEvents {
    onlocationerror?(event: Leaflet.ErrorEvent): void;
    onlocationfound?(event: Leaflet.LocationEvent): void;
}
interface LeafletInteractionEvents {
    onclick?(event: Leaflet.MouseEvent): void;
    ondblclick?(event: Leaflet.MouseEvent): void;
    onmousedown?(event: Leaflet.MouseEvent): void;
    onmouseup?(event: Leaflet.MouseEvent): void;
    onmouseover?(event: Leaflet.MouseEvent): void;
    onmouseout?(event: Leaflet.MouseEvent): void;
    onmousemove?(event: Leaflet.MouseEvent): void;
    oncontextmenu?(event: Leaflet.MouseEvent): void;
    onkeypress?(event: Leaflet.KeyboardEvent): void;
    onpreclick?(event: Leaflet.MouseEvent): void;
}
interface LeafletOtherEvents {
    onzoomanim?(event: Leaflet.ZoomAnimEvent): void;
}
interface LeafletDraggingEvents {
    ondragstart?(event: Leaflet.Event): void;
    onmovestart?(event: Leaflet.Event): void;
    ondrag?(event: Leaflet.Event): void;
    ondragend?(event: Leaflet.DragEndEvent): void;
    onmoveend?(event: Leaflet.Event): void;
}

type LeafletEvents = LeafletLayerEvents
    & LeafletMapStateChangeEvents
    & LeafletPopupEvents
    & LeafletTooltipEvents
    & LeafletLocationEvents
    & LeafletInteractionEvents
    & LeafletOtherEvents
    & LeafletDraggingEvents;

type MapComponentProps = React.HTMLProps<MapProps> & LeafletEvents;

export class MapComponent<P extends MapComponentProps, E extends Leaflet.Class> extends React.Component<P, {}> {
    _leafletEvents: LeafletEvents;
    leafletElement: E;
    extractLeafletEvents(props: P): LeafletEvents;
    bindLeafletEvents(next: LeafletEvents, prev: LeafletEvents): LeafletEvents;
    fireLeafletEvent(type: string, data: any): void;
    getOptions(props: P): P;
}

export interface MapProps extends MapComponentProps, Leaflet.MapOptions {
    animate?: boolean;
    bounds?: Leaflet.LatLngBoundsExpression;
    boundsOptions?: Leaflet.FitBoundsOptions;
    center?: Leaflet.LatLngExpression;
    children?: Children;
    className?: string;
    id?: string,
    maxBounds?: Leaflet.LatLngBoundsExpression;
    maxZoom?: number;
    minZoom?: number;
    style?: React.CSSProperties;
    useFlyTo?: boolean;
    zoom?: number;
}

export class Map<P extends MapProps, E extends Leaflet.Map> extends MapComponent<P, E> {
    className?: string;
    container: HTMLDivElement;
    getChildContext(): { layerContainer: E, map: E };
    createLeafletElement(props: P): E;
    updateLeafletElement(fromProps: P, toProps: P): void;
    bindContainer(container: HTMLDivElement): void;
    shouldUpdateCenter(next: Leaflet.LatLngExpression, prev: Leaflet.LatLngExpression): boolean;
    shouldUpdateBounds(next: Leaflet.LatLngBoundsExpression, prev: Leaflet.LatLngBoundsExpression): boolean;
}

export interface PaneProps extends MapComponentProps {
    name?: string;
    style?: React.CSSProperties;
    className?: string;
}
export interface PaneState {
    name?: string;
}
export class Pane<P extends PaneProps, S extends PaneState> extends React.Component<P, S> {
    getChildContext(): { pane: string };
    createPane(props: P): void;
    removePane(): void;
    setStyle(arg: { style?: string, className?: string }): void;
    getParentPane(): HTMLElement | undefined;
    getPane(name: string): HTMLElement | undefined;
}

export interface MapLayerProps extends MapComponentProps {
    children?: Children;
}
export interface LayerContainer {
    addLayer(layer: Leaflet.Layer): this;
    removeLayer(layer: number | Leaflet.Layer): this;
}
export class MapLayer<P extends MapLayerProps, E extends Leaflet.Class> extends MapComponent<P, E> {
    createLeafletElement(props: P): E;
    updateLeafletElement(fromProps: P, toProps: P): void;
    readonly layerContainer: LayerContainer | Leaflet.Map;
}

// There is no Layer class, these are the base props for all layers on the map
interface LayerProps extends LeafletInteractionEvents {
    onadd?(event: Leaflet.Event): void;
    onremove?(event: Leaflet.Event): void;

    // Popup events
    onpopupopen?(event: Leaflet.PopupEvent): void;
    onpopupclose?(event: Leaflet.PopupEvent): void;

    // Tooltip events
    ontooltipopen?(event: Leaflet.TooltipEvent): void;
    ontooltipclose?(event: Leaflet.TooltipEvent): void;
}

export interface MarkerProps extends MapLayerProps, Leaflet.MarkerOptions {
    position: Leaflet.LatLngExpression;
}
export class Marker<P extends MarkerProps, E extends Leaflet.Marker> extends MapLayer<P, E> {
    getChildContext(): { popupContainer: E };
}

export interface PopupProps extends Leaflet.PopupOptions {
    children?: Children;
    position?: Leaflet.LatLngExpression;
}
export class Popup<P extends PopupProps, E extends Leaflet.Popup> extends MapComponent<P, E> {
    onPopupOpen(arg: { popup: E }): void;
    onPopupClose(arg: { popup: E }): void;
    renderPopupContent(): void;
    removePopupContent(): void;
}

export interface TooltipProps extends Leaflet.TooltipOptions {
    children?: Children;
}
export class Tooltip<P extends TooltipProps, E extends Leaflet.Tooltip> extends MapComponent<P, E> {
    onTooltipOpen(arg: { tooltip: E }): void;
    onTooltipClose(arg: { tooltip: E }): void;
    renderTooltipContent(): void;
    removeTooltipContent(): void;
}

interface GridLayerProps extends LayerProps {
    opacity?: number;
    zIndex?: number;

    onloading?(event: Leaflet.Event): void;
    ontileunload?(event: Leaflet.TileEvent): void;
    ontileloadstart?(event: Leaflet.TileEvent): void;
    ontileerror?(event: Leaflet.TileErrorEvent): void;
    ontileload?(event: Leaflet.TileEvent): void;
    onload?(event: Leaflet.Event): void;
}
export const GridLayer: React.ComponentClass<GridLayerProps>;

interface TileLayerProps extends GridLayerProps, Leaflet.TileLayerOptions {
    url: string;
}
export const TileLayer: React.ComponentClass<TileLayerProps>;

interface ImageOverlayProps extends LayerProps, LeafletInteractionEvents {
    url: string;
    opacity?: string;
}
export const ImageOverlay: React.ComponentClass<ImageOverlayProps>;

interface WMSTileLayerProps extends TileLayerProps {
    url: string;
}
export const WMSTileLayer: React.ComponentClass<WMSTileLayerProps>;

// Path is an abstract class
// tslint:disable-next-line:no-empty-interface
interface PathProps extends LeafletLayerEvents, LeafletInteractionEvents, Leaflet.PathOptions {
}

interface CircleProps extends PathProps {
    center: Leaflet.LatLngExpression;
    radius?: number;
}
export const Circle: React.ComponentClass<CircleProps>;

interface CircleMarkerProps extends PathProps {
    center: Leaflet.LatLngExpression;
    radius?: number;
}
export const CircleMarker: React.ComponentClass<CircleMarkerProps>;

interface PolylineProps extends PathProps {
    positions: Leaflet.LatLngExpression[] | Leaflet.LatLngExpression[][];
}
export const Polyline: React.ComponentClass<PolylineProps>;

interface PolygonProps extends PathProps {
    positions: Leaflet.LatLngExpression[] | Leaflet.LatLngExpression[][] | Leaflet.LatLngExpression[][][];
}
export const Polygon: React.ComponentClass<PolygonProps>;

interface RectangleProps extends PathProps {
    bounds: Leaflet.LatLngBoundsExpression;
}
export const Rectangle: React.ComponentClass<RectangleProps>;

// tslint:disable-next-line:no-empty-interface
interface LayerGroupProps extends LayerProps { }
export const LayerGroup: React.ComponentClass<LayerGroupProps>;

// tslint:disable-next-line:no-empty-interface
interface FeatureGroupProps extends LayerGroupProps, Leaflet.PathOptions { }
export const FeatureGroup: React.ComponentClass<FeatureGroupProps>;

interface GeoJSONProps extends FeatureGroupProps, Leaflet.GeoJSONOptions {
    data: GeoJSON.GeoJsonObject;
}
export const GeoJSON: React.ComponentClass<GeoJSONProps>;

interface AttributionControlProps {
    position?: Leaflet.ControlPosition;
}
export const AttributionControl: React.ComponentClass<AttributionControlProps>;

interface LayersControlProps {
    position?: Leaflet.ControlPosition;
}
export const LayersControl: React.ComponentClass<LayersControlProps> & { BaseLayer: LayersControl.BaseLayer, Overlay: LayersControl.Overlay };

export namespace LayersControl {
    interface LayersControlLayerProps {
        name: string;
        checked?: boolean;
    }
    type BaseLayer = React.ComponentClass<LayersControlLayerProps>;
    type Overlay = React.ComponentClass<LayersControlLayerProps>;
}

interface MapControlProps {
    position?: Leaflet.ControlPosition;
}
export class MapControl<T extends MapControlProps> extends React.Component<T, any> {
    leafletElement?: L.Control;
}

interface ScaleControlProps {
    position: Leaflet.ControlPosition;
}
export const ScaleControl: React.ComponentClass<ScaleControlProps>;

interface ZoomControlProps {
    position: Leaflet.ControlPosition;
}
export const ZoomControl: React.ComponentClass<ZoomControlProps>;