@mapcomponents/react-maplibre 0.1.96 → 1.0.1

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

@@ -1,98 +1,98 @@
-/// <reference types="react" />
-import { Feature, FeatureCollection } from '@turf/turf';
-import { useLayerProps } from '../../hooks/useLayer';
-import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification, LayerSpecification, RasterLayerSpecification } from 'maplibre-gl';
-export 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.
-     * All types from LayerSpecification union type are supported except the type from
-     * RasterLayerSpecification
-     */
-    type?: Exclude<LayerSpecification['type'], RasterLayerSpecification['type']>;
-    /**
-     * @deprecated The property should not be used. Please use the options.paint property instead. This will be removed in the next major release.
-     * Paint property object, that is passed to the addLayer call.
-     * Possible props depend on the layer type.
-     * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
-     * Some examples are:
-     * 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
-     * All paint types from LayerSpecification union type are supported except the paint type from
-     * RasterLayerSpecification
-     */
-    paint?: Exclude<LayerSpecification['paint'], RasterLayerSpecification['paint']>;
-    /**
-     * @deprecated The property should not be used. Please use the options.layout property instead. This will be removed in the next major release.
-     * Layout property object, that is passed to the addLayer call.
-     * Possible props depend on the layer type.
-     * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
-     * Some examples are:
-     * 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
-     * All layout types from LayerSpecification union type are supported except the layout type from
-     * RasterLayerSpecification
+import React from 'react';
+import { Feature, FeatureCollection } from '@turf/turf';
+import { useLayerProps } from '../../hooks/useLayer';
+import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification, LayerSpecification, RasterLayerSpecification } from 'maplibre-gl';
+export 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?: GeoJSON.Feature | GeoJSON.FeatureCollection | Feature | FeatureCollection | undefined;
+    /**
+     * Type of the layer that will be added to the MapLibre instance.
+     * All types from LayerSpecification union type are supported except the type from
+     * RasterLayerSpecification
+     */
+    type?: Exclude<LayerSpecification['type'], RasterLayerSpecification['type']>;
+    /**
+     * @deprecated The property should not be used. Please use the options.paint property instead. This will be removed in the next major release.
+     * Paint property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
+     * Some examples are:
+     * 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
+     * All paint types from LayerSpecification union type are supported except the paint type from
+     * RasterLayerSpecification
+     */
+    paint?: Exclude<LayerSpecification['paint'], RasterLayerSpecification['paint']>;
+    /**
+     * @deprecated The property should not be used. Please use the options.layout property instead. This will be removed in the next major release.
+     * Layout property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
+     * Some examples are:
+     * 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
+     * All layout types from LayerSpecification union type are supported except the layout type from
+     * RasterLayerSpecification
 
-     */
-    layout?: LayerSpecification['layout'];
-    /**
-     * Javascript object that is spread into the addLayer commands first parameter.
-     */
-    options?: useLayerProps['options'];
-    /**
-     * 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'];
-    };
-    /**
-     * Property name in the GeoJSON object to be used as a label.
-     */
-    labelProp?: string;
-    /**
-     * Label configuration options.
-     */
-    labelOptions?: useLayerProps['options'];
-    /**
-     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
-     */
-    onHover?: useLayerProps['onHover'];
-    /**
-     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
-     */
-    onClick?: useLayerProps['onClick'];
-    /**
-     * Leave event handler that is executed whenever a geometry rendered by this component is
-     * left/unhovered.
-     */
-    onLeave?: useLayerProps['onLeave'];
-};
-/**
- * Adds source and layer to display GeoJSON data on the map.
- *
- * @component
- */
-declare const MlGeoJsonLayer: (props: MlGeoJsonLayerProps) => JSX.Element;
-export default MlGeoJsonLayer;
+     */
+    layout?: LayerSpecification['layout'];
+    /**
+     * Javascript object that is spread into the addLayer commands first parameter.
+     */
+    options?: useLayerProps['options'];
+    /**
+     * 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'];
+    };
+    /**
+     * Property name in the GeoJSON object to be used as a label.
+     */
+    labelProp?: string;
+    /**
+     * Label configuration options.
+     */
+    labelOptions?: useLayerProps['options'];
+    /**
+     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
+     */
+    onHover?: useLayerProps['onHover'];
+    /**
+     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
+     */
+    onClick?: useLayerProps['onClick'];
+    /**
+     * Leave event handler that is executed whenever a geometry rendered by this component is
+     * left/unhovered.
+     */
+    onLeave?: useLayerProps['onLeave'];
+};
+/**
+ * Adds source and layer to display GeoJSON data on the map.
+ *
+ * @component
+ */
+declare const MlGeoJsonLayer: (props: MlGeoJsonLayerProps) => React.JSX.Element;
+export default MlGeoJsonLayer;

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

@@ -1,2 +1,9 @@
-export default LineStyler;
-declare function LineStyler(props: any): JSX.Element;
+import React from 'react';
+import { GeoJSON } from 'geojson';
+interface LineStylerProps {
+    geojson: GeoJSON;
+    openSidebar: boolean;
+    setOpenSidebar: (open: boolean) => void;
+}
+declare const LineStyler: React.FC<LineStylerProps>;
+export default LineStyler;

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

@@ -1,2 +1,8 @@
-export default PolygonStyler;
-declare function PolygonStyler(props: any): JSX.Element;
+import React from 'react';
+interface PolygonStylerProps {
+    geojson: GeoJSON.FeatureCollection;
+    openSidebar: boolean;
+    setOpenSidebar: (open: boolean) => void;
+}
+declare const PolygonStyler: React.FC<PolygonStylerProps>;
+export default PolygonStyler;

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

@@ -1,4 +1,4 @@
-/// <reference types="react" />
-import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer';
-declare const CircleMapStyler: (props: MlGeoJsonLayerProps) => JSX.Element;
-export default CircleMapStyler;
+import React from 'react';
+import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer';
+declare const CircleMapStyler: (props: MlGeoJsonLayerProps) => React.JSX.Element;
+export default CircleMapStyler;

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

@@ -1,4 +1,4 @@
-/// <reference types="react" />
-import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer';
-declare const HeatMapStyler: (props: MlGeoJsonLayerProps) => JSX.Element;
-export default HeatMapStyler;
+import React from 'react';
+import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer';
+declare const HeatMapStyler: (props: MlGeoJsonLayerProps) => React.JSX.Element;
+export default HeatMapStyler;

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

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

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

@@ -1,5 +1,5 @@
-import { LayerSpecification, RasterLayerSpecification } from 'maplibre-gl';
-declare const getDefaultPaintPropsByType: (type: string, defaultPaintOverrides?: {
-    [key: string]: unknown;
-} | undefined) => Exclude<LayerSpecification['paint'], RasterLayerSpecification['paint']>;
-export default getDefaultPaintPropsByType;
+import { LayerSpecification, RasterLayerSpecification } from 'maplibre-gl';
+declare const getDefaultPaintPropsByType: (type: string, defaultPaintOverrides?: {
+    [key: string]: unknown;
+} | undefined) => Exclude<LayerSpecification['paint'], RasterLayerSpecification['paint']>;
+export default getDefaultPaintPropsByType;

package/dist/components/MlGeojsonLayerWithSource/MlGeojsonLayerWithSource.d.ts

@@ -1,23 +1,23 @@
-/// <reference types="react" />
-export interface MlGeojsonLayerWithSourceProps {
-    /**
-     * 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.
-     */
-    insertBeforeLayer?: string;
-}
-/**
- * MlGeojsonLayerWithSource
- *
- */
-declare const MlGeojsonLayerWithSource: {
-    (props: MlGeojsonLayerWithSourceProps): JSX.Element;
-    defaultProps: {
-        mapId: string;
-    };
-};
-export default MlGeojsonLayerWithSource;
+import React from "react";
+export interface MlGeojsonLayerWithSourceProps {
+    /**
+     * 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.
+     */
+    insertBeforeLayer?: string;
+}
+/**
+ * MlGeojsonLayerWithSource
+ *
+ */
+declare const MlGeojsonLayerWithSource: {
+    (props: MlGeojsonLayerWithSourceProps): React.JSX.Element;
+    defaultProps: {
+        mapId: string;
+    };
+};
+export default MlGeojsonLayerWithSource;

package/dist/components/MlGpxViewer/MlGpxViewer.d.ts

@@ -1,31 +1,31 @@
-/// <reference types="react" />
-import { FeatureCollection } from '@turf/turf';
-import { MetadataType } from '../../hooks/useGpx/useGpx';
-export 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;
-    gpxData: string | undefined;
-    onParseGpxData: (arg0: {
-        geojson: FeatureCollection | undefined;
-        metadata: MetadataType[];
-    }) => void;
-}
-/**
- * MlGpxViewer visualizes a given GPX Track on the map
- */
-declare const MlGpxViewer: {
-    (props: MlGpxViewerProps): JSX.Element;
-    defaultProps: {};
-};
-export default MlGpxViewer;
+import React from 'react';
+import { FeatureCollection } from '@turf/turf';
+import { MetadataType } from '../../hooks/useGpx/useGpx';
+export 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;
+    gpxData: string | undefined;
+    onParseGpxData: (arg0: {
+        geojson: FeatureCollection | undefined;
+        metadata: MetadataType[];
+    }) => void;
+}
+/**
+ * MlGpxViewer visualizes a given GPX Track on the map
+ */
+declare const MlGpxViewer: {
+    (props: MlGpxViewerProps): React.JSX.Element;
+    defaultProps: {};
+};
+export default MlGpxViewer;

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

@@ -1,10 +1,10 @@
-import React from "react";
-import { FeatureCollection } from '@turf/turf';
-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;
+import React from "react";
+import { FeatureCollection } from '@turf/turf';
+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

@@ -1,5 +1,5 @@
-/// <reference types="react" />
-declare const GeoJsonProvider: ({ children }: {
-    children: JSX.Element;
-}) => JSX.Element;
-export default GeoJsonProvider;
+import React from "react";
+declare const GeoJsonProvider: ({ children }: {
+    children: JSX.Element;
+}) => React.JSX.Element;
+export default GeoJsonProvider;

package/dist/components/MlGpxViewer/util/Metadata.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
-import { MetadataType } from '../../../hooks/useGpx/useGpx';
-type Props = {
-    metadata: MetadataType[];
-};
-export default function Metadata(props: Props): JSX.Element;
-export {};
+import React from 'react';
+import { MetadataType } from '../../../hooks/useGpx/useGpx';
+type Props = {
+    metadata: MetadataType[];
+};
+export default function Metadata(props: Props): React.JSX.Element;
+export {};

package/dist/components/MlGpxViewer/util/MlGpxDemoLoader.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="react" />
-interface MlGpxDemoLoaderProps {
-    open: boolean;
-    close: () => void;
-    setGpx: (gpx: string | undefined) => void;
-}
-/**
- * MlGpxDemoLoader returns a button to load a Demo GPX Track into the map.
- */
-declare const MlGpxDemoLoader: (props: MlGpxDemoLoaderProps) => JSX.Element;
-export default MlGpxDemoLoader;
+import React from 'react';
+interface MlGpxDemoLoaderProps {
+    open: boolean;
+    close: () => void;
+    setGpx: (gpx: string | undefined) => void;
+}
+/**
+ * MlGpxDemoLoader returns a button to load a Demo GPX Track into the map.
+ */
+declare const MlGpxDemoLoader: (props: MlGpxDemoLoaderProps) => React.JSX.Element;
+export default MlGpxDemoLoader;

package/dist/components/MlGpxViewer/util/MlGpxViewerInstructions.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
-export default function MlGpxViewerInstructions(props: {
-    open: boolean;
-}): JSX.Element;
+import React from 'react';
+export default function MlGpxViewerInstructions(props: {
+    open: boolean;
+}): React.JSX.Element;

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

@@ -1,39 +1,39 @@
-/// <reference types="react" />
-import { SymbolLayerSpecification } from 'maplibre-gl';
-import { Feature, FeatureCollection } from '@turf/turf';
-export 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?: {
-        source?: {
-            type?: string | undefined;
-            data: Feature | FeatureCollection | undefined;
-        };
-        layout?: SymbolLayerSpecification['layout'];
-        paint?: SymbolLayerSpecification['paint'];
-    };
-}
-declare const MlImageMarkerLayer: (props: MlImageMarkerLayerProps) => JSX.Element;
-export default MlImageMarkerLayer;
+import React from 'react';
+import { SymbolLayerSpecification } from 'maplibre-gl';
+import { Feature, FeatureCollection } from '@turf/turf';
+export 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?: {
+        source?: {
+            type?: string | undefined;
+            data: Feature | FeatureCollection | undefined;
+        };
+        layout?: SymbolLayerSpecification['layout'];
+        paint?: SymbolLayerSpecification['paint'];
+    };
+}
+declare const MlImageMarkerLayer: (props: MlImageMarkerLayerProps) => React.JSX.Element;
+export default MlImageMarkerLayer;

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

@@ -1,33 +1,33 @@
-/// <reference types="react" />
-import { useLayerProps } from '../../hooks/useLayer';
-import { Feature, FeatureCollection } from '@turf/turf';
-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?: useLayerProps['options'];
-    /**
-     * GeoJSON data that is supposed to be rendered by this component.
-     */
-    geojson?: Feature | FeatureCollection | undefined;
-}
-/**
- * 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;
+import React from 'react';
+import { useLayerProps } from '../../hooks/useLayer';
+import { Feature, FeatureCollection } from '@turf/turf';
+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?: useLayerProps['options'];
+    /**
+     * GeoJSON data that is supposed to be rendered by this component.
+     */
+    geojson?: Feature | FeatureCollection | undefined;
+}
+/**
+ * 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) => React.JSX.Element;
+export default MlLayer;