Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 1.92 KB

README.md

File metadata and controls

85 lines (56 loc) · 1.92 KB
Raw
npm package

mapbox-gl-draw-history

History plugin for mapbox-gl-draw.

screen-capture

Requires mapbox-gl-js and mapbox-gl-draw

Installing

npm install mapbox-gl-draw-history

Package ships with CSS, make sure you include it in your build.

Usage in your application

JavaScript

import mapboxgl from "mapbox-gl";
import MapboxDraw from "@mapbox/mapbox-gl-draw";
import MapboxDrawHistory from "mapbox-gl-draw-history";

CSS

import "mapbox-gl-draw-history/dist/mapbox-gl-draw-history.css";

Example usage

mapboxgl.accessToken = 'YOUR_ACCESS_TOKEN';

const map = new mapboxgl.Map({
  container: 'map',
  style: 'mapbox://styles/mapbox/streets-v12',
  center: [40, -74.50],
  zoom: 9
});

const Draw = new MapboxDraw();
map.addControl(Draw, 'top-left');

const DrawHistory = new MapboxDrawHistory(Draw, { keybindings: true });
map.addControl(DrawHistory, 'top-left');

map.on('load', function() {
  // ALL YOUR APPLICATION CODE
});

See API.md for complete reference.

Developing and testing

Install dependencies, build the source files and crank up a server via:

git clone [email protected]:Starmordar/mapbox-gl-draw-history.git
npm install
npm run start-server & open "http://localhost:3000/example/?access_token=<token>"

Publishing

To GitHub and NPM:

npm version (major|minor|patch)
git push --tags
git push
npm publish