@leolovesmile/leaflet4vue v0.1.1

leaflet for vue 3

This library is based on the project vue-leaflet. I forked that repository on 2021-06-03, because that I am afraid that I need to change/add some components and I need do releases frequently.

I keep the LICENSE untouched and change the name of this library.

What Works:

• LCircle
• LCircleMarker
• LControl
• LControlAttribution
• LControlLayers
• LControlScale
• LControlZoom
• LFeatureGroup
• LGeoJson
• LIcon
• LImageOverlay
• LMap
• LMarker
• LPolygon
• LPolyline
• LPopup
• LRectangle
• LTileLayer
• LTooltip
• LWmsTileLayer

Note that unlike the Vue 2 version, this library is fully compatible with SSR.

Installation

yarn add @leolovesmile/leaflet4vue

or

npm i -D @leolovesmile/leaflet4vue

Usage

Until the complete documentation is ready, please check the component playground examples or the demo project for usage with Vue 3. Most component props mimic the vanilla Leaflet options as closely as possible, and generally remain the same as in their Vue2Leaflet counterparts.

Working with Leaflet

N.B. Using import L from "leaflet" or import { ... } from "leaflet" can lead to unexpected errors.

To provide server-side rendering and tree-shaking capabilities, vue-leaflet uses async imports from the Leaflet ESM. This can lead to issues when importing additional methods from Leaflet, because the two instances of the Leaflet classes are technically no longer the same. See Issue 48 for more.

To avoid these issues, import any Leaflet methods asynchronously in response to the LMap component's @ready event:

<template>
  <l-map style="height:50vh">
    <l-geo-json :geojson="geojson" :options="geojsonOptions" />
  </l-map>
</template>

<script>
// DON'T load Leaflet components here!
// Its CSS is needed though, if not imported elsewhere in your application.
import "leaflet/dist/leaflet.css"
import { LMap, LGeoJson } from "@leolovesmile/leaflet4vue";

export default {
  components: {
    LMap,
    LGeoJson,
  },
  data() {
    return {
      geojson: {
        type: "FeatureCollection",
        features: [
          // ...
        ],
      },
      geojsonOptions: {
        // Options that don't rely on Leaflet methods.
      },
    };
  },
  async beforeMount() {
    // HERE is where to load Leaflet components!
    const { circleMarker } = await import("leaflet/dist/leaflet-src.esm");

    // And now the Leaflet circleMarker function can be used by the options:
    this.geojsonOptions.pointToLayer = (feature, latLng) =>
      circleMarker(latLng, { radius: 8 });
    this.mapIsReady = true;
  },
};
</script>