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

// Type definitions for react-leaflet 1.0
// Project: https://github.com/PaulLeCam/react-leaflet
// Definitions by: Dave Leaver <https://github.com/danzel>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

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

export 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;
}
export 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;
}
export interface LeafletPopupEvents {
    onpopupopen?(event: Leaflet.PopupEvent): void;
    onpopupclose?(event: Leaflet.PopupEvent): void;
    onautopanstart?(event: Leaflet.Event): void;
}
export interface LeafletTooltipEvents {
    ontooltipopen?(event: Leaflet.TooltipEvent): void;
    ontooltipclose?(event: Leaflet.TooltipEvent): void;
}
export interface LeafletLocationEvents {
    onlocationerror?(event: Leaflet.ErrorEvent): void;
    onlocationfound?(event: Leaflet.LocationEvent): void;
}
export 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;
}
export interface LeafletOtherEvents {
    onzoomanim?(event: Leaflet.ZoomAnimEvent): void;
}
export 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;
}

export interface MapProps extends React.HTMLProps<Map>,
    LeafletLayerEvents, LeafletMapStateChangeEvents, LeafletPopupEvents, LeafletTooltipEvents, LeafletLocationEvents, LeafletInteractionEvents, LeafletOtherEvents, Leaflet.MapOptions {
    animate?: boolean;
    bounds?: Leaflet.LatLngBoundsExpression;
    boundsOptions?: Leaflet.FitBoundsOptions;
    className?: string;
    style?: React.CSSProperties;
    useFlyTo?: boolean;

    id?: string;
}
export type Map = React.ComponentClass<MapProps>;
export const Map: Map;
export interface MapInstance extends React.Component<MapProps, {}> {
    leafletElement: Leaflet.Map;
}

export interface PaneProps {
    name?: string;
    style?: React.CSSProperties;
    className?: string;
}
export const Pane: React.ComponentClass<PaneProps>;

// There is no Layer class, these are the base props for all layers on the map
export 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 LayerProps, LeafletDraggingEvents {
    position: Leaflet.LatLngExpression;
    draggable?: boolean;
    icon?: Leaflet.BaseIcon;
    zIndexOffset?: number;
    opacity?: number;
}
export const Marker: React.ComponentClass<MarkerProps>;
export interface MarkerInstance extends React.Component<MarkerProps, {}> {
    leafletElement: Leaflet.Marker;
}

export interface PopupProps extends LayerProps, Leaflet.PopupOptions {
    position?: Leaflet.LatLngExpression;
}
export const Popup: React.ComponentClass<PopupProps>;

// tslint:disable-next-line:no-empty-interface
export interface TooltipProps extends LayerProps, Leaflet.TooltipOptions { }
export const Tooltip: React.ComponentClass<TooltipProps>;

export 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>;

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

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

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

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

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

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

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

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

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

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

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

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

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

export 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>;
}

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

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

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