vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-07 00:07:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[react-map-gl] MapContext and missing TransitionEvent (#36297)

Browse Source 
* add TRANSITION_EVENTS.UPDATE

* add _MapContext

* lint fixes

* extend PureComponent

* nullable
This commit is contained in:
Fabio Berta
2019-06-19 16:37:39 -07:00
committed by Daniel Rosenwasser
parent d50e08515d
commit 3df8f6b229
1 changed files with 58 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/react-map-gl/index.d.ts
Vendored
+58 -38
View File
@@ -1,4 +1,4 @@
// Type definitions for react-map-gl 4.1
// Type definitions for react-map-gl 5.0
// Project: https://github.com/uber/react-map-gl#readme
// Definitions by: Robert Imig <https://github.com/rimig>
// Fabio Berta <https://github.com/fnberta>
@@ -9,6 +9,7 @@
import * as React from 'react';
import * as MapboxGL from 'mapbox-gl';
import * as GeoJSON from 'geojson';
import WebMercatorViewport from 'viewport-mercator-project';
export interface ViewState {
latitude: number;
@@ -73,7 +74,7 @@ export interface QueryRenderedFeaturesParams {
filter?: any[];
}
export class StaticMap extends React.Component<StaticMapProps> {
export class StaticMap extends React.PureComponent<StaticMapProps> {
getMap(): MapboxGL.Map;
queryRenderedFeatures(geometry?: MapboxGL.PointLike | MapboxGL.PointLike[], parameters?: QueryRenderedFeaturesParams): Array<GeoJSON.Feature<GeoJSON.GeometryObject>>;
}
@@ -87,8 +88,10 @@ export interface PositionInput {
pos: [number, number];
}
export type ViewportChangeHandler = (viewState: ViewState) => void;
export interface MapControllerOptions {
onViewportChange?: (viewState: ViewState) => void;
onViewportChange?: ViewportChangeHandler;
onStateChange?: (state: MapState) => void;
eventManager?: any;
isInteractive: boolean;
@@ -193,7 +196,8 @@ export type EasingFunction = (t: number) => number;
export enum TRANSITION_EVENTS {
BREAK = 1,
SNAP_TO_END = 2,
IGNORE = 3
IGNORE = 3,
UPDATE = 4
}
export class TransitionInterpolator {}
@@ -208,13 +212,15 @@ export interface ViewStateChangeInfo {
viewState: ViewState;
}
export type ViewStateChangeHandler = (info: ViewStateChangeInfo) => void;
export interface InteractiveMapProps extends StaticMapProps {
maxZoom?: number;
minZoom?: number;
maxPitch?: number;
minPitch?: number;
onViewStateChange?: (info: ViewStateChangeInfo) => void;
onViewportChange?: (viewState: ViewState) => void;
onViewStateChange?: ViewStateChangeHandler;
onViewportChange?: ViewportChangeHandler;
onInteractionStateChange?: (state: ExtraState) => void;
transitionDuration?: number;
transitionInterpolator?: TransitionInterpolator;
@@ -252,13 +258,28 @@ export interface InteractiveMapProps extends StaticMapProps {
controller?: MapController;
}
export class InteractiveMap extends React.Component<InteractiveMapProps> {
export class InteractiveMap extends React.PureComponent<InteractiveMapProps> {
getMap(): MapboxGL.Map;
queryRenderedFeatures(geometry?: MapboxGL.PointLike | MapboxGL.PointLike[], parameters?: QueryRenderedFeaturesParams): Array<GeoJSON.Feature<GeoJSON.GeometryObject>>;
}
export default InteractiveMap;
// class EventManager from mjolnir.js
export type EventManager = any;
export interface MapContextProps {
viewport?: WebMercatorViewport;
map?: MapboxGL.Map;
mapContainer: HTMLElement | null;
onViewStateChange?: ViewStateChangeHandler;
onViewportChange?: ViewportChangeHandler;
isDragging: boolean;
eventManager?: EventManager;
}
export const _MapContext: React.Context<MapContextProps>;
export interface BaseControlProps {
captureScroll?: boolean;
captureDrag?: boolean;
@@ -266,27 +287,11 @@ export interface BaseControlProps {
captureDoubleClick?: boolean;
}
export class BaseControl<T extends BaseControlProps> extends React.Component<T> {}
export interface DragEvent {
lngLat: [number, number];
[key: string]: any;
export class BaseControl<T extends BaseControlProps, S extends Element> extends React.PureComponent<T> {
_containerRef: React.RefObject<S>;
_context: MapContextProps;
}
export interface MarkerProps extends BaseControlProps {
className?: string;
longitude: number;
latitude: number;
offsetLeft?: number;
offsetTop?: number;
draggable?: boolean;
onDrag?: (event: DragEvent) => void;
onDragEnd?: (event: DragEvent) => void;
onDragStart?: (event: DragEvent) => void;
}
export class Marker extends BaseControl<MarkerProps> {}
export interface PopupProps extends BaseControlProps {
className?: string;
longitude: number;
@@ -303,24 +308,24 @@ export interface PopupProps extends BaseControlProps {
onClose?: () => void;
}
export class Popup extends BaseControl<PopupProps> {}
export class Popup extends BaseControl<PopupProps, HTMLDivElement> {}
export interface NavigationControlProps extends BaseControlProps {
className?: string;
onViewStateChange?: (info: ViewStateChangeInfo) => void;
onViewportChange?: (viewport: ViewState) => void;
onViewStateChange?: ViewStateChangeHandler;
onViewportChange?: ViewportChangeHandler;
showCompass?: boolean;
showZoom?: boolean;
}
export class NavigationControl extends BaseControl<NavigationControlProps> {}
export class NavigationControl extends BaseControl<NavigationControlProps, HTMLDivElement> {}
export interface FullscreenControlProps extends BaseControlProps {
className?: string;
container?: HTMLElement | null;
}
export class FullscreenControl extends BaseControl<FullscreenControlProps> {}
export class FullscreenControl extends BaseControl<FullscreenControlProps, HTMLDivElement> {}
export interface GeolocateControlProps extends BaseControlProps {
className?: string;
@@ -328,11 +333,16 @@ export interface GeolocateControlProps extends BaseControlProps {
fitBoundsOptions?: MapboxGL.FitBoundsOptions;
trackUserLocation?: boolean;
showUserLocation?: boolean;
onViewStateChange?: (info: ViewStateChangeInfo) => void;
onViewportChange?: (viewState: ViewState) => void;
onViewStateChange?: ViewStateChangeHandler;
onViewportChange?: ViewportChangeHandler;
}
export class GeolocateControl extends BaseControl<GeolocateControlProps> {}
export class GeolocateControl extends BaseControl<GeolocateControlProps, HTMLDivElement> {}
export interface DragEvent {
lngLat: [number, number];
[key: string]: any;
}
export interface DraggableControlProps extends BaseControlProps {
draggable?: boolean;
@@ -341,7 +351,17 @@ export interface DraggableControlProps extends BaseControlProps {
onDragStart?: (event: DragEvent) => void;
}
export class DraggableControl extends BaseControl<DraggableControlProps> {}
export class DraggableControl<T extends DraggableControlProps> extends BaseControl<T, HTMLDivElement> {}
export interface MarkerProps extends DraggableControlProps {
className?: string;
longitude: number;
latitude: number;
offsetLeft?: number;
offsetTop?: number;
}
export class Marker extends DraggableControl<MarkerProps> {}
export interface HTMLRedrawOptions {
width: number;
@@ -355,7 +375,7 @@ export interface HTMLOverlayProps extends BaseControlProps {
style?: React.CSSProperties;
}
export class HTMLOverlay extends BaseControl<HTMLOverlayProps> {}
export class HTMLOverlay extends BaseControl<HTMLOverlayProps, HTMLDivElement> {}
export interface CanvasRedrawOptions extends HTMLRedrawOptions {
ctx: CanvasRenderingContext2D;
@@ -365,7 +385,7 @@ export interface CanvasOverlayProps extends BaseControlProps {
redraw: (opts: CanvasRedrawOptions) => void;
}
export class CanvasOverlay extends BaseControl<CanvasOverlayProps> {}
export class CanvasOverlay extends BaseControl<CanvasOverlayProps, HTMLCanvasElement> {}
export type SVGRedrawOptions = HTMLRedrawOptions;
@@ -374,4 +394,4 @@ export interface SVGOverlayProps extends BaseControlProps {
style?: React.CSSProperties;
}
export class SVGOverlay extends BaseControl<SVGOverlayProps> {}
export class SVGOverlay extends BaseControl<SVGOverlayProps, Element> {}