Leaflet controller

A Typescript friendly stateful map controller for Leaflet

Install

Install Leaflet first or use your already installed version and install the map controller:

npm install leaflet-controller
# or
yarn add leaflet-controller
Copy

Usage

The map controller manages the state of the features on the map. The state object keeps track of:

• Markers: marker controllers on the map
• Polylines: polyline controllers on the map
• Polygons: polygon controllers on the map
• Controller groups: group of controllers on the map

The map controller has optional geolocation features

Map controller

A map controller:

import { useMapController} from "leaflet-controller";

const mapController = useMapController();
Copy

Initialize a map once the map container is mounted:

mapController.setMap({
    container: "mapContainer",
    center: [46.192043, 6.774619],
    zoom: 16,
    options: { attributionControl: false, zoomControl: true, zoomAnimation: false },
  })
Copy

Documentation of the parameters

Map methods

• resize: trigger a map resize
• resetMap: reset the map to it's initial state: center and zoom and clear all items on map

Marker methods

• addMarkerController: add a marker controller
• removeMarkerController: remove a marker controller

Geolocation methods

• setLocate: set the on location found callback
• resetLocate: reset the on location found callback to default
• fitUserLatlng: fit bounds for given coordinates and user position
• distanceFromUser: calculate the distance from given coordinates to the user position

Marker controller

A marker controller. Create a marker:

import { useMarkerController } from "leaflet-controller";

const markerController = useMarkerController({
  name: "marker_id",
  latlng: [0,0],
  iconOptions: {
    className: `text-primary text-2xl`,
    html: "<svg ...></svg>"
  },
});
Copy

Push the marker on the map:

mapController.addMarkerController(markerController)
Copy

Remove it from the map:

mapController.removeMarkerController("marker_id")
Copy

Marker icons

To change the css class of the marker div container:

mapController.state.markers["marker_id"].cls("text-danger text-2xl")
Copy

To add to the css class of the marker div container:

mapController.state.markers["marker_id"].addToCls("border-2 border-success p-1")
Copy

Marker svg icons

The controller manages the svg markers and can apply css classes directly on the marker not it's div container like above. To initialize a svg marker:

const markerController = useMarkerController({
  // other parameters ...
  iconSvg: "<svg ...></svg>",
  svgCls: `border-2 rounded-full p-1`
});
Copy

It is possible to change and add to the css class of the svg tag like above with the svgCls and addToSvgCls methods

Polyline controller

A polyline controller

import L from "leaflet";
import { usePolylineController } from "leaflet-controller";

const polyline = usePolylineController({
  name: "polyline_id",
  polyline: L.polyline([[45.51, -122.68], [37.77, -122.43]]),
})
Copy

Add it to the map:

mapController.addPolylineController(polylineController)
Copy

Remove it from the map:

mapController.removePolylineController("polyline_id")
Copy

Polygon controller

A polygon controller

import L from "leaflet";
import { usePolygonController } from "leaflet-controller";

const polygon = usePolygonController({
  name: "polygon_id",
  polygon: L.polygon([[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]]),
})
Copy

Add it to the map:

polygonController.polygon.addTo(mapController.map)
Copy

Remove it from the map:

mapController.removePolygonController("polygon_id")
Copy

Controllers group

A group of controllers. It will be managed on the map as a Leaflet FeatureGroup:

import { useControllerGroup } from "leaflet-controller";

const group = useControllerGroup({
    name: "group_id",
    controllers: [markerController, polylineController, polygonController]
  })
Copy

Push the group on the map:

mapController.addGroup(group)
Copy

Access the group features:

import L from "leaflet";

const features: L.FeatureGroup = mapController.state.groups["group_id"].features
Copy

Remove the group from the map:

mapController.removeGroup("group_id")
Copy

Geolocation features

To enable the user geolocation:

mapController.setMap({
  // other parameters ...
  location: true,
  onLocationUpdate: (e) => console.log("Location update", e.latlng), // optional
})
Copy

It is possible to change the on location update callback. Example: calculate the distance from the user to a location and use it in a reactive Vue property:

import L from "leaflet";
import { reactive } from "@vue/reactivity";

const point = markerController.marker.getLatLng();
const geolocState = reactive({ distance: 0 });

mapController.setLocate((event: L.LocationEvent) => {
  // the map controller will update the prop everytime a location update occurs
  geolocState.distance = Math.trunc(mapController.distanceFromUser(event.latlng))
})
Copy