@geoman-io/maplibre-geoman-free NPM

Documentation

Visit geoman.io/docs/maplibre to get started.

Issues

If you have support questions or want to report issues, please create an issue in this repository. Use this repository for issues related to both the free and pro versions of Maplibre-Geoman.

Demo

Check out the full power of Maplibre-Geoman Pro on geoman.io/demo/maplibre

Or watch a demo video on YouTube

Installation

Free Version

# install free version
npm install @geoman-io/maplibre-geoman-free

Pro Version

Add the following content to .npmrc in your project root

#.npmrc
@geoman-io:registry=https://npm.geoman.io/
//npm.geoman.io/:_authToken="<YOUR LICENSE KEY>"

Replace <YOUR LICENSE KEY> with your license key.

# install pro version
npm install @geoman-io/maplibre-geoman-pro

Don't have a license key yet? Purchase one here.

Usage

Examples

Framework/Template	Demo URL	Code URL	Description
maplibre-geoman-vite	Demo	Code	Vanilla JavaScript implementation using Vite as the build tool
maplibre-geoman-vue	Demo	Code	Vue.js integration showcasing reactive map editing capabilities
maplibre-geoman-react	Demo	Code	React implementation with hooks and components for map editing
maplibre-geoman-preact	Demo	Code	Lightweight Preact alternative to the React implementation
maplibre-geoman-nextjs	Demo	Code	Next.js integration with server-side rendering support
maplibre-geoman-svelte	Demo	Code	Svelte implementation offering reactive map editing features

Expected HTML Structure

<!-- index.html -->
<html lang="en_US">
  <head>
    <title>Geoman Maplibre</title>
    <style>
      #dev-map {
        height: 100vh;
        width: 100vw;
      }
    </style>
  </head>
  <body>
    <div id="dev-map"></div>
  </body>
</html>

Maplibre and Geoman initialization

import ml from "maplibre-gl";
import { type GmOptionsPartial } from "@geoman-io/maplibre-geoman-pro";

import "maplibre-gl/dist/maplibre-gl.css";
import "@geoman-io/maplibre-geoman-pro/dist/maplibre-geoman.css";

const mapStyle: ml.StyleSpecification = {
  version: 8,
  glyphs: "https://demotiles.maplibre.org/font/{fontstack}/{range}.pbf",
  sources: {
    "osm-tiles": {
      type: "raster",
      tiles: ["https://tile.openstreetmap.org/{z}/{x}/{y}.png"],
      tileSize: 256,
      attribution: "© OpenStreetMap contributors",
    },
  },
  layers: [
    {
      id: "osm-tiles-layer",
      type: "raster",
      source: "osm-tiles",
      minzoom: 0,
      maxzoom: 19,
    },
  ],
};

const map = new ml.Map({
  container: "dev-map",
  style: mapLibreStyle,
  center: [0, 51],
  zoom: 5,
});

const gmOptions: GmOptionsPartial = {
  // geoman options here
};

const geoman = new Geoman(map, gmOptions);

map.on("gm:loaded", () => {
  console.log("Geoman fully loaded");

  // Here you can add your geojson shapes for example
  const shapeGeoJson = {
    type: "Feature",
    geometry: { type: "Point", coordinates: [0, 51] },
  };
  map.gm.features.addGeoJsonFeature({ shapeGeoJson });
});

Contributing

We welcome contributions from the community! Please read our CONTRIBUTING.md for guidelines on how to get started, report issues, and submit pull requests.

Code of Conduct

We are committed to fostering a welcoming and respectful community. Please read our Code of Conduct before participating.

Security Policy

If you discover a security vulnerability, please see our Security Policy for responsible disclosure guidelines.

License & Commercial Use

This repository is licensed under the MIT License, which means you are free to use, modify, and distribute this software for any purpose, including commercial use. The free version of Maplibre-Geoman is fully open source. However, please note that the Pro version of Maplibre-Geoman is not open source and requires a commercial license, which can be purchased at geoman.io/pricing. See LICENSE for full license details.