@mapcomponents/react-maplibre 0.1.51 → 0.1.54

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcomponents/react-maplibre",
-  "version": "0.1.51",
+  "version": "0.1.54",
   "main": "index.js",
   "license": "MIT",
   "module": "dist/index.esm.js",

package/scripts/create-map-component.sh

@@ -18,14 +18,14 @@ if [ ! -d "$target_path$component_name" ]; then
 
   mv $target_path$component_name/$template_name.doc.de.md $target_path$component_name/$component_name.doc.de.md
 
-  mv $target_path$component_name/$template_name.js $target_path$component_name/$component_name.js
+  mv $target_path$component_name/$template_name.tsx $target_path$component_name/$component_name.tsx
 
   mv $target_path$component_name/$template_name.meta_.json $target_path$component_name/$component_name.meta_.json
 
   mv $target_path$component_name/$template_name.stories.js $target_path$component_name/$component_name.stories.js
 
   sed -i "s/$template_name/$component_name/g" $target_path$component_name/$component_name.doc.de.md
-  sed -i "s/$template_name/$component_name/g" $target_path$component_name/$component_name.js
+  sed -i "s/$template_name/$component_name/g" $target_path$component_name/$component_name.tsx
   sed -i "s/$template_name/$component_name/g" $target_path$component_name/$component_name.meta_.json
   sed -i "s/$template_name/$component_name/g" $target_path$component_name/$component_name.stories.js
 

package/src/components/MlCenterPosition/MlCenterPosition.doc.de.md

@@ -0,0 +1,3 @@
+# Component Beschreibung
+
+Beschreibungstext

package/src/components/MlCenterPosition/MlCenterPosition.meta_.json

@@ -0,0 +1,15 @@
+{
+  "name": "MlCenterPosition",
+  "title": "",
+  "description": "",
+  "i18n": {
+    "de": {
+      "title": "",
+      "description": ""
+    }
+  },
+  "tags": [],
+  "category": "",
+  "type": "component",
+  "price": 0
+}

package/src/components/MlCenterPosition/MlCenterPosition.stories.js

@@ -0,0 +1,21 @@
+import React from "react";
+
+import MlCenterPosition from "./MlCenterPosition";
+
+import mapContextDecorator from "../../decorators/MapContextDecorator";
+
+const storyoptions = {
+  title: "MapComponents/MlCenterPosition",
+  component: MlCenterPosition,
+  argTypes: {
+  },
+  decorators: mapContextDecorator,
+  parameters: { docs: { source: { type: 'code' } } }
+};
+export default storyoptions;
+
+const Template = (args) => <MlCenterPosition />;
+
+export const ExampleConfig = Template.bind({});
+ExampleConfig.parameters = {};
+ExampleConfig.args = {};

package/src/components/MlCenterPosition/MlCenterPosition.tsx

@@ -0,0 +1,86 @@
+import React, { useState, useCallback } from "react";
+import useMap from "../../hooks/useMap";
+import { Button } from "@mui/material";
+import  GpsFixedIcon  from "@mui/icons-material/GpsFixed";
+
+interface MlCenterPositionProps {
+  /**
+   * 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;
+  /**
+   * Active button font color
+   */
+  onColor?: string;
+  /**
+   * Inactive button font color
+   */
+  offColor?: string;
+  /**
+   * CSS style object that is applied to the button component
+   */
+  style?: any;
+}
+
+/**
+ * Component template
+ *
+ */
+const MlCenterPosition = (props: MlCenterPositionProps) => {
+  const mapHook = useMap({
+    mapId: props.mapId,
+    waitForLayer: props.insertBeforeLayer,
+  });
+  const [locationAccessDenied, setLocationAccessDenied] = useState(false);
+
+  const centerCurrentLocation = () => {
+    navigator.geolocation.getCurrentPosition(getLocationSuccess, getLocationError);
+  };
+
+  const getLocationSuccess = useCallback((location) => {
+    mapHook.map?.map.setCenter?.([location.coords.longitude, location.coords.latitude]);
+  }, [mapHook.map]);
+
+  const getLocationError = () => {
+    console.log("Access of user location denied");
+    setLocationAccessDenied(true);
+  };
+  return <>
+      <Button 
+        sx={{
+          zIndex: 1002,
+          color: !locationAccessDenied ? props.onColor : props.offColor,
+          ...props.style,
+        }}
+       onClick={centerCurrentLocation} disabled={locationAccessDenied}>
+        <GpsFixedIcon sx={{ ...(props.style?.fontSize?{fontSize: props.style?.fontSize}:{}) }} />{" "}
+      </Button>
+  </>;
+
+};
+
+MlCenterPosition.defaultProps = {
+  mapId: undefined,
+  style: {
+    minWidth: "30px",
+    minHeight: "30px",
+    width: "30px",
+    height: "30px",
+    backgroundColor: "#414141",
+    borderRadius: "23%",
+    margin: 0.15,
+    fontSize: "1.3em",
+    ":hover": {
+      backgroundColor: "#515151",
+      color: "#ececec",
+    },
+  },
+  onColor: "#ececec",
+  offColor: "#666",
+};
+export default MlCenterPosition;

package/src/components/MlGeoJsonLayer/MlGeoJsonLayer.tsx

@@ -43,7 +43,7 @@ type MlGeoJsonLayerProps = {
    * 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'];
+  paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
   /**
    * Layout property object, that is passed to the addLayer call.
    * Possible props depend on the layer type.

package/src/components/MlLayer/MlLayer.tsx

@@ -1,6 +1,7 @@
 import React from "react";
 
 import useLayer from "../../hooks/useLayer";
+import { Feature, FeatureCollection } from "@turf/turf";
 
 interface MlLayerProps {
   /**
@@ -20,6 +21,10 @@ interface MlLayerProps {
    * Javascript object that is passed the addLayer command as first parameter.
    */
   options?: any;
+  /**
+   * GeoJSON data that is supposed to be rendered by this component.
+   */
+  geojson: Feature | FeatureCollection | undefined;
 }
 
 /**
@@ -32,6 +37,7 @@ const MlLayer = (props: MlLayerProps) => {
     idPrefix: 'MlLayer-',
     layerId: props.layerId,
     mapId: props.mapId,
+    geojson: props.geojson,
     options: {
       type: "background",
       paint: {

package/src/components/MlNavigationTools/MlNavigationTools.stories.js

@@ -2,7 +2,9 @@ import React from "react";
 
 import MlNavigationTools from "./MlNavigationTools";
 
-import mapContextDecorator from "../../decorators/MapContextDecorator";
+import noNavToolsDecorator from "../../decorators/NoNavToolsDecorator";
+import BuildIcon from "@mui/icons-material/Build";
+import Button from "@mui/material/Button";
 
 const storyoptions = {
   title: "MapComponents/MlNavigationTools",
@@ -11,12 +13,47 @@ const storyoptions = {
     url: {},
     layer: {},
   },
-  decorators: mapContextDecorator,
+  decorators: noNavToolsDecorator,
 };
 export default storyoptions;
 
-const Template = (args) => <MlNavigationTools />;
+const Template = (args) => <MlNavigationTools {...args} />;
 
-export const ExampleConfig = Template.bind({});
-ExampleConfig.parameters = {};
-ExampleConfig.args = {};
+export const DefaultConfig = Template.bind({});
+DefaultConfig.parameters = {};
+DefaultConfig.args = {};
+
+export const No3DButton = Template.bind({});
+No3DButton.parameters = {};
+No3DButton.args = {
+  show3DButton: false,
+};
+
+export const ShowCenterLocationButton = Template.bind({});
+ShowCenterLocationButton.parameters = {};
+ShowCenterLocationButton.args = {
+  showFollowGpsButton: false,
+  showCenterLocationButton: true,
+};
+
+export const NoZoomButtons = Template.bind({});
+NoZoomButtons.parameters = {};
+NoZoomButtons.args = {
+  showZoomButtons: false,
+};
+
+export const NoFollowGpsButton = Template.bind({});
+NoFollowGpsButton.parameters = {};
+NoFollowGpsButton.args = {
+  showFollowGpsButton: false,
+};
+
+export const CustomButton = Template.bind({});
+CustomButton.parameters = {};
+CustomButton.args = {
+  children: (
+    <Button onClick={() => {}}>
+      <BuildIcon sx={{ fontSize: "1em" }} />
+    </Button>
+  ),
+};

package/src/components/MlNavigationTools/MlNavigationTools.tsx

@@ -8,13 +8,41 @@ import MlNavigationCompass from "../MlNavigationCompass/MlNavigationCompass";
 import MlFollowGps from "../MlFollowGps/MlFollowGps";
 import useMediaQuery from "@mui/material/useMediaQuery";
 import useMap from "../../hooks/useMap";
+import MlCenterPosition from "../MlCenterPosition/MlCenterPosition";
 
 interface MlNavigationToolsProps {
+  /**
+   * 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;
+  /**
+   * Show 3D button
+   */
+  show3DButton?: boolean;
+  /**
+   * Show zoom button
+   */
+  showZoomButtons?: boolean;
+  /**
+   * Show follow GPS button
+   */
+  showFollowGpsButton?: boolean;
+  /**
+   * Show center on current position button
+   */
+  showCenterLocationButton?: boolean;
+  /**
+   * Additional JSX Elements to be rendered below MlNavigationTools buttons
+   */
+  children?: JSX.Element;
 }
 
- /**
+/**
  * @component
  */
 const MlNavigationTools = (props: MlNavigationToolsProps) => {
@@ -35,31 +63,35 @@ const MlNavigationTools = (props: MlNavigationToolsProps) => {
     //border: "1px solid #bbb",
     //boxShadow: "0px 0px 4px rgba(0,0,0,.5)",
     margin: 0.15,
-    fontSize: mediaIsMobile ? "1.5em" : "1.2em",
+    fontSize: mediaIsMobile ? "1.4em" : "1.2em",
     ":hover": {
       backgroundColor: "#515151",
     },
     color: "#ececec",
   };
+  const iconStyle = {
+    fontSize: buttonStyle.fontSize,
+  }
 
   useEffect(() => {
     if (!mapHook.map) return;
 
-    mapHook.map.on("pitchend", () => {
-      if (!mapHook.map) return;
+    mapHook.map.on(
+      "pitchend",
+      () => {
+        if (!mapHook.map) return;
 
-      setPitch(mapHook.map.map.getPitch());
-    },mapHook.componentId);
+        setPitch(mapHook.map.map.getPitch());
+      },
+      mapHook.componentId
+    );
     setPitch(mapHook.map.map.getPitch());
   }, [mapHook.map, props.mapId]);
 
   const zoomIn = () => {
     if (!mapHook.map) return;
 
-    if (
-      mapHook.map.map.transform._zoom + 0.5 <=
-      mapHook.map.map.transform._maxZoom
-    ) {
+    if (mapHook.map.map.transform._zoom + 0.5 <= mapHook.map.map.transform._maxZoom) {
       mapHook.map.map.easeTo({ zoom: mapHook.map.map.transform._zoom + 0.5 });
     }
   };
@@ -67,10 +99,7 @@ const MlNavigationTools = (props: MlNavigationToolsProps) => {
   const zoomOut = () => {
     if (!mapHook.map) return;
 
-    if (
-      mapHook.map.map.transform._zoom - 0.5 >=
-      mapHook.map.map.transform._minZoom
-    ) {
+    if (mapHook.map.map.transform._zoom - 0.5 >= mapHook.map.map.transform._minZoom) {
       mapHook.map.map.easeTo({ zoom: mapHook.map.map.transform._zoom - 0.5 });
     }
   };
@@ -108,10 +137,20 @@ const MlNavigationTools = (props: MlNavigationToolsProps) => {
           boxShadow: "0px 0px 18px rgba(0,0,0,.5)",
         }}
       />
-      <Button sx={{ ...buttonStyle, fontSize:mediaIsMobile?'1.4em':'1em', fontWeight: 600 }} onClick={adjustPitch}>
-        {pitch ? "2D" : "3D"}
-      </Button>
-      <MlFollowGps style={{ ...(({ color, ...rest }) => rest)(buttonStyle) }} />
+      {props.show3DButton && (
+        <Button
+          sx={{ ...buttonStyle, fontSize: mediaIsMobile ? "1.4em" : "1em", fontWeight: 600 }}
+          onClick={adjustPitch}
+        >
+          {pitch ? "2D" : "3D"}
+        </Button>
+      )}
+      {props.showFollowGpsButton && (
+        <MlFollowGps style={{ ...(({ color, ...rest }) => rest)(buttonStyle) }} />
+      )}
+      {props.showCenterLocationButton && (
+        <MlCenterPosition style={{ ...(({ color, ...rest }) => rest)(buttonStyle) }} />
+      )}
       <ButtonGroup
         orientation="vertical"
         sx={{
@@ -121,19 +160,31 @@ const MlNavigationTools = (props: MlNavigationToolsProps) => {
           "Button:hover": { border: "none" },
         }}
       >
-        <Button sx={{ ...buttonStyle, color: "#ececec" }} onClick={zoomIn}>
-          <ControlPointIcon
-            sx={{ fontSize: mediaIsMobile ? "1.5em" : "1.2em" }}
-          />
-        </Button>
-        <Button sx={{ ...buttonStyle, color: "#ececec" }} onClick={zoomOut}>
-          <RemoveCircleOutlineIcon
-            sx={{ fontSize: mediaIsMobile ? "1.5em" : "1.2em" }}
-          />
-        </Button>
+        {props.showZoomButtons && (
+          <>
+            <Button sx={{ ...buttonStyle }} onClick={zoomIn}>
+              <ControlPointIcon sx={{...iconStyle}} />
+            </Button>
+            <Button sx={{ ...buttonStyle }} onClick={zoomOut}>
+              <RemoveCircleOutlineIcon  sx={{...iconStyle}} />
+            </Button>
+          </>
+        )}
       </ButtonGroup>
+      {props.children &&
+        React.cloneElement(props.children, {
+          sx: { ...buttonStyle },
+        })}
     </div>
   );
 };
 
+MlNavigationTools.defaultProps = {
+  mapId: undefined,
+  show3DButton: true,
+  showFollowGpsButton: true,
+  showCenterLocationButton: false,
+  showZoomButtons: true,
+};
+
 export default MlNavigationTools;

package/src/components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer.tsx

@@ -32,7 +32,7 @@ interface MlTransitionGeoJsonLayerProps {
    * 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'];
+  paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
   /**
    * Layout property object, that is passed to the addLayer call.
    * Possible props depend on the layer type.

package/src/decorators/NoNavToolsDecorator.js

@@ -0,0 +1,31 @@
+import React from "react";
+
+import { MapComponentsProvider } from "../index";
+import MapLibreMap from "../components/MapLibreMap/MapLibreMap";
+import "./style.css";
+import { createTheme, ThemeProvider } from "@mui/material/styles";
+import MlNavgiationTools from "../components/MlNavigationTools/MlNavigationTools";
+
+const theme = createTheme({});
+
+const decorators = [
+  (Story) => (
+    <div className="fullscreen_map">
+      <ThemeProvider theme={theme}>
+        <MapComponentsProvider>
+          <Story />
+          <MapLibreMap
+            options={{
+              zoom: 14.5,
+              style: "https://wms.wheregroup.com/tileserver/style/osm-bright.json",
+              center: [7.0851268, 50.73884],
+            }}
+            mapId="map_1"
+          />
+        </MapComponentsProvider>
+      </ThemeProvider>
+    </div>
+  ),
+];
+
+export default decorators;