@mapcomponents/react-maplibre 0.1.46 → 0.1.51

package/dist/components/MlFeatureEditor/lib/theme.d.ts

@@ -0,0 +1,88 @@
+declare var _default: ({
+    id: string;
+    type: string;
+    filter: (string | string[])[];
+    paint: {
+        "fill-color": string;
+        "fill-outline-color": string;
+        "fill-opacity": number;
+        "circle-radius"?: undefined;
+        "circle-color"?: undefined;
+        "line-color"?: undefined;
+        "line-width"?: undefined;
+        "line-dasharray"?: undefined;
+        "circle-opacity"?: undefined;
+    };
+    layout?: undefined;
+} | {
+    id: string;
+    type: string;
+    filter: (string | string[])[];
+    paint: {
+        "circle-radius": number;
+        "circle-color": string;
+        "fill-color"?: undefined;
+        "fill-outline-color"?: undefined;
+        "fill-opacity"?: undefined;
+        "line-color"?: undefined;
+        "line-width"?: undefined;
+        "line-dasharray"?: undefined;
+        "circle-opacity"?: undefined;
+    };
+    layout?: undefined;
+} | {
+    id: string;
+    type: string;
+    filter: (string | string[])[];
+    layout: {
+        "line-cap": string;
+        "line-join": string;
+    };
+    paint: {
+        "line-color": string;
+        "line-width": number;
+        "fill-color"?: undefined;
+        "fill-outline-color"?: undefined;
+        "fill-opacity"?: undefined;
+        "circle-radius"?: undefined;
+        "circle-color"?: undefined;
+        "line-dasharray"?: undefined;
+        "circle-opacity"?: undefined;
+    };
+} | {
+    id: string;
+    type: string;
+    filter: (string | string[])[];
+    layout: {
+        "line-cap": string;
+        "line-join": string;
+    };
+    paint: {
+        "line-color": string;
+        "line-dasharray": number[];
+        "line-width": number;
+        "fill-color"?: undefined;
+        "fill-outline-color"?: undefined;
+        "fill-opacity"?: undefined;
+        "circle-radius"?: undefined;
+        "circle-color"?: undefined;
+        "circle-opacity"?: undefined;
+    };
+} | {
+    id: string;
+    type: string;
+    filter: (string | string[])[];
+    paint: {
+        "circle-radius": number;
+        "circle-opacity": number;
+        "circle-color": string;
+        "fill-color"?: undefined;
+        "fill-outline-color"?: undefined;
+        "fill-opacity"?: undefined;
+        "line-color"?: undefined;
+        "line-width"?: undefined;
+        "line-dasharray"?: undefined;
+    };
+    layout?: undefined;
+})[];
+export default _default;

package/dist/components/MlFeatureEditor/lib/to_dense_array.d.ts

@@ -0,0 +1,12 @@
+export default toDenseArray;
+/**
+ * Code from https://github.com/mapbox/mapbox-gl-draw
+ * and licensed under ISC
+ */
+/**
+ * Derive a dense array (no `undefined`s) from a single value or array.
+ *
+ * @param {any} x
+ * @return {Array<any>}
+ */
+declare function toDenseArray(x: any): Array<any>;

package/dist/components/MlFeatureEditor/lib/utils.d.ts

@@ -0,0 +1,10 @@
+export default drawUtils;
+declare namespace drawUtils {
+    function getMatchingVertices(vertex: any, featureId: any, allFeatures: any, map: any): {
+        featureId: any;
+        coord_path: string;
+        lng: any;
+        lat: any;
+    }[];
+    function getDrawInstance(map: any): any;
+}

package/dist/components/MlFillExtrusionLayer/MlFillExtrusionLayer.d.ts

@@ -0,0 +1,61 @@
+interface MlFillExtrusionLayerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Id of the layer that will be added by this component
+     */
+    layerId?: string;
+    /**
+     * Paint properties of the config object that is passed to the MapLibreGl.addLayer call. All
+     * available properties are documented in the MapLibreGl documentation
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill-extrusion
+     */
+    paint?: object;
+    /**
+     * Source id of a vector tile source containing the geometries to use for this fill-extrusion
+     * layer.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#source-layer
+     */
+    sourceId?: string;
+    /**
+     * Layer id from a vector tile source containing the geometries to use for this fill-extrusion
+     * layer.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#source-layer
+     */
+    sourceLayer?: string;
+    /**
+     * This layer will be hidden for zoom levels lower than defined on this property
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#minzoom
+     */
+    minZoom?: number;
+}
+/**
+ * Adds a fill extrusion layer to the MapLibre instance reference by props.mapId
+ *
+ */
+declare const MlFillExtrusionLayer: {
+    (props: MlFillExtrusionLayerProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+        paint: {
+            "fill-extrusion-color": string;
+            "fill-extrusion-height": {
+                property: string;
+                type: string;
+            };
+            "fill-extrusion-base": {
+                property: string;
+                type: string;
+            };
+            "fill-extrusion-opacity": number;
+        };
+    };
+};
+export default MlFillExtrusionLayer;

package/dist/components/MlFillExtrusionLayer/MlFillExtrusionLayer.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlFillExtrusionLayer as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlFillExtrusionLayer from "./MlFillExtrusionLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlFillExtrusionLayer/MlFillExtrusionLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlFollowGps/MlFollowGps.d.ts

@@ -0,0 +1,80 @@
+interface MlFollowGpsProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * By default a dot will be shown on the map at the user's location. Set to false to disable.
+     */
+    showUserLocation?: boolean;
+    /**
+     * By default a cone will be shown on the map at the user's location to indicate the device's orientation.
+     * Set to false to disable.
+     */
+    showOrientation?: boolean;
+    /**
+     * By default, if showUserLocation is true, a transparent circle will be drawn around the user location
+     * indicating the accuracy (95% confidence level) of the user's location. Set to false to disable.
+     */
+    showAccuracyCircle?: boolean;
+    /**
+     * position circle paint property object, that is passed to the MlGeoJsonLayer responsible for drawing the accuracy circle.
+     * Use any available paint prop from layer type "fill".
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    circlePaint?: any;
+    /**
+     * Active button font color
+     */
+    onColor?: string;
+    /**
+     * Inactive button font color
+     */
+    offColor?: string;
+    /**
+     * Accuracy paint property object, that is passed to the MlGeoJsonLayer responsible for drawing the accuracy circle.
+     * Use any available paint prop from layer type "fill".
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    accuracyPaint?: any;
+    /**
+     * CSS style object that is applied to the button component
+     */
+    style?: any;
+}
+/**
+ * Adds a button that makes the map follow the users GPS position using
+ * navigator.geolocation.watchPosition if activated
+ *
+ */
+declare const MlFollowGps: {
+    (props: MlFollowGpsProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+        style: {
+            minWidth: string;
+            minHeight: string;
+            width: string;
+            height: string;
+            backgroundColor: string;
+            borderRadius: string;
+            margin: number;
+            fontSize: string;
+            ":hover": {
+                backgroundColor: string;
+                color: string;
+            };
+        };
+        onColor: string;
+        offColor: string;
+        showAccuracyCircle: boolean;
+        showUserLocation: boolean;
+        showOrientation: boolean;
+    };
+};
+export default MlFollowGps;

package/dist/components/MlFollowGps/MlFollowGps.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlFollowGps as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlFollowGps from "./MlFollowGps";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlFollowGps/MlFollowGps.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlGPXViewer/MlGPXViewer.d.ts

@@ -0,0 +1,29 @@
+interface MlGPXViewerProps {
+    /**
+     * Id of the target MapLibre instance in mapHook
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Prefix of the component id this component uses when adding elements to the MapLibreGl-instance
+     */
+    idPrefix?: string;
+    /**
+     * Sets the layers layout-property "visibility" to "none" if false or "visible" if true
+     */
+    visible?: boolean;
+}
+/**
+ * MlGPXViewer returns a dropzone and a button to load a GPX Track into the map.
+ */
+declare const MlGPXViewer: {
+    (props: MlGPXViewerProps): JSX.Element;
+    defaultProps: {
+        visible: boolean;
+    };
+};
+export default MlGPXViewer;

package/dist/components/MlGPXViewer/MlGPXViewer.stories.d.ts

@@ -0,0 +1,16 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlGPXViewer as component };
+    export namespace argTypes {
+        namespace options {
+            namespace control {
+                const type: string;
+            }
+        }
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlGPXViewer from "./MlGPXViewer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlGPXViewer/MlGPXViewer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlGPXViewer/gpxConverter.d.ts

@@ -0,0 +1,11 @@
+export default toGeoJSON;
+declare namespace toGeoJSON {
+    function kml(doc: any): {
+        type: string;
+        features: never[];
+    };
+    function gpx(doc: any): {
+        type: string;
+        features: never[];
+    };
+}

package/dist/components/MlGPXViewer/util/GeoJsonContext.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { FeatureCollection } from '@turf/turf';
+declare type ContextProps = {
+    data: FeatureCollection;
+    setData: Function;
+    getEmptyFeatureCollection: Function;
+};
+declare const GeoJsonContext: React.Context<Partial<ContextProps>>;
+export declare const GeoJsonContextProvider: React.Provider<Partial<ContextProps>>;
+export default GeoJsonContext;

package/dist/components/MlGPXViewer/util/GeoJsonProvider.d.ts

@@ -0,0 +1,4 @@
+declare const GeoJsonProvider: ({ children }: {
+    children: JSX.Element;
+}) => JSX.Element;
+export default GeoJsonProvider;

package/dist/components/MlGeoJsonLayer/MlGeoJsonLayer.d.ts

@@ -0,0 +1,76 @@
+import { Feature, FeatureCollection } from "@turf/turf";
+import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification, MapLayerMouseEvent } from "maplibre-gl";
+declare type MlGeoJsonLayerProps = {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     * This layer will not be added to the maplibre-gl instance until a layer with an
+     * id that matches the value of insertBeforeLayer is created.
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Id of the new layer and source that are added to the MapLibre instance
+     */
+    layerId?: string;
+    /**
+     * GeoJSON data that is supposed to be rendered by this component.
+     */
+    geojson: Feature | FeatureCollection | undefined;
+    /**
+     * Type of the layer that will be added to the MapLibre instance.
+     * Possible values: "line", "circle", "fill"
+     */
+    type?: "fill" | "line" | "circle";
+    /**
+     * Paint property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['layout'];
+    /**
+     * Layout property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    layout?: CircleLayerSpecification['layout'] | FillLayerSpecification['layout'] | LineLayerSpecification['layout'];
+    /**
+     * Javascript object that is spread into the addLayer commands first parameter.
+     */
+    options?: CircleLayerSpecification | FillLayerSpecification | LineLayerSpecification;
+    /**
+     * Javascript object with optional properties "fill", "line", "circle" to override implicit layer type default paint properties.
+     */
+    defaultPaintOverrides?: {
+        circle?: CircleLayerSpecification['paint'];
+        fill?: FillLayerSpecification['paint'];
+        line?: LineLayerSpecification['paint'];
+    };
+    /**
+     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
+     */
+    onHover?: MapLayerMouseEvent;
+    /**
+     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
+     */
+    onClick?: MapLayerMouseEvent;
+    /**
+     * Leave event handler that is executed whenever a geometry rendered by this component is
+     * left/unhovered.
+     */
+    onLeave?: MapLayerMouseEvent;
+};
+/**
+ * Adds source and layer of types "line", "fill" or "circle" to display GeoJSON data on the map.
+ *
+ * @component
+ */
+declare const MlGeoJsonLayer: (props: MlGeoJsonLayerProps) => JSX.Element;
+export default MlGeoJsonLayer;

package/dist/components/MlGeoJsonLayer/MlGeoJsonLayer.stories.d.ts

@@ -0,0 +1,12 @@
+export default storyoptions;
+export const Linestring: any;
+export const Polygon: any;
+export const DefaultPaintOverrides: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlGeoJsonLayer as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlGeoJsonLayer from "./MlGeoJsonLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlGeoJsonLayer/MlGeoJsonLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlGeoJsonLayer/util/getDefaultLayerTypeByGeometry.d.ts

@@ -0,0 +1,2 @@
+declare const getDefaulLayerTypeByGeometry: Function;
+export default getDefaulLayerTypeByGeometry;

package/dist/components/MlGeoJsonLayer/util/getDefaultPaintPropsByType.d.ts

@@ -0,0 +1,2 @@
+declare const getDefaultPaintPropsByType: Function;
+export default getDefaultPaintPropsByType;

package/dist/components/MlImageMarkerLayer/MlImageMarkerLayer.d.ts

@@ -0,0 +1,29 @@
+interface MlImageMarkerLayerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Id of the layer that will be added by this component to the maplibre-gl instance
+     */
+    layerId?: string;
+    /**
+     * Id of the image that will be added by this component to the maplibre-gl instance
+     */
+    imageId?: string;
+    /**
+     * Path or URL to a supported raster image
+     */
+    imgSrc?: string;
+    /**
+     * Javascript object that is passed the addLayer command as first parameter.
+     */
+    options?: any;
+}
+declare const MlImageMarkerLayer: (props: MlImageMarkerLayerProps) => JSX.Element;
+export default MlImageMarkerLayer;

package/dist/components/MlImageMarkerLayer/MlImageMarkerLayer.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlImageMarkerLayer as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlImageMarkerLayer from "./MlImageMarkerLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlImageMarkerLayer/MlImageMarkerLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlLayer/MlLayer.d.ts

@@ -0,0 +1,26 @@
+interface MlLayerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Id of the layer that will be added by this component to the maplibre-gl instance
+     */
+    layerId?: string;
+    /**
+     * Javascript object that is passed the addLayer command as first parameter.
+     */
+    options?: any;
+}
+/**
+ * Basic layer component that create a layer in a MapLibre-gl instance and keeps it updated according to it attribute configuration.
+ *
+ * @category Map components
+ */
+declare const MlLayer: (props: MlLayerProps) => JSX.Element;
+export default MlLayer;

package/dist/components/MlLayer/MlLayer.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlLayer as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlLayer from "./MlLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlLayer/MlLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlLayerMagnify/MlLayerMagnify.d.ts

@@ -0,0 +1,27 @@
+import "./style.css";
+interface MlLayerMagnifyProps {
+    /**
+     * Id of the first MapLibre instance
+     */
+    map1Id: string;
+    /**
+     * Id of the second MapLibre instance
+     */
+    map2Id: string;
+    /**
+     * Size of the "magnifier"-circle
+     */
+    magnifierRadius?: number;
+}
+/**
+ *
+ * Hides the MapLibreMap referenced by props.map2Id except for the "magnifier"-circle that reveals
+ * the map and can be dragged around on top of the MapLibreMap referenced by props.map1Id
+ */
+declare const MlLayerMagnify: {
+    (props: MlLayerMagnifyProps): JSX.Element;
+    defaultProps: {
+        magnifierRadius: number;
+    };
+};
+export default MlLayerMagnify;

package/dist/components/MlLayerMagnify/MlLayerMagnify.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlLayerMagnify as component };
+    export const argTypes: {};
+    export { multiMapContextDecorator as decorators };
+}
+import MlLayerMagnify from "./MlLayerMagnify";
+import multiMapContextDecorator from "../../decorators/MultiMapContextDecorator";

package/dist/components/MlLayerMagnify/MlLayerMagnify.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlLayerSwipe/MlLayerSwipe.d.ts

@@ -0,0 +1,16 @@
+import "./style.css";
+interface MlLayerSwipeProps {
+    /**
+     * Id of the first MapLibre instance.
+     */
+    map1Id: string;
+    /**
+     * Id of the second MapLibre instance.
+     */
+    map2Id: string;
+}
+/**
+ *  creates a split view of 2 synchronised maplibre instances
+ */
+declare const MlLayerSwipe: (props: MlLayerSwipeProps) => JSX.Element;
+export default MlLayerSwipe;

package/dist/components/MlLayerSwipe/MlLayerSwipe.stories.d.ts

@@ -0,0 +1,11 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export const name: string;
+    export { MlLayerSwipe as component };
+    export const argTypes: {};
+    export { multiMapContextDecorator as decorators };
+}
+import MlLayerSwipe from "./MlLayerSwipe";
+import multiMapContextDecorator from "../../decorators/MultiMapContextDecorator";

package/dist/components/MlLayerSwipe/MlLayerSwipe.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlLayerSwitcher/MlLayerSwitcher.d.ts

@@ -0,0 +1,30 @@
+export default MlLayerSwitcher;
+/**
+ * @component
+ *
+ *
+ */
+declare function MlLayerSwitcher(props: any): JSX.Element;
+declare namespace MlLayerSwitcher {
+    namespace propTypes {
+        const baseSourceConfig: PropTypes.Requireable<PropTypes.InferProps<{
+            label: PropTypes.Requireable<string>;
+            layers: PropTypes.Requireable<(PropTypes.InferProps<{
+                layerId: PropTypes.Validator<string>;
+                src: PropTypes.Requireable<string>;
+                label: PropTypes.Validator<string>;
+            }> | null | undefined)[]>;
+        }>>;
+        const detailLayerConfig: PropTypes.Requireable<PropTypes.InferProps<{
+            label: PropTypes.Requireable<string>;
+            layers: PropTypes.Requireable<(PropTypes.InferProps<{
+                layerId: PropTypes.Validator<string>;
+                src: PropTypes.Requireable<string>;
+                label: PropTypes.Validator<string>;
+                linkedTo: PropTypes.Requireable<string>;
+            }> | null | undefined)[]>;
+        }>>;
+        const mapId: PropTypes.Requireable<string>;
+    }
+}
+import PropTypes from "prop-types";