lightning-maps

Lightning Maps (Alpha release)

A lightweight, dependency-free slippy map renderer.

Heavily inspired by Pigeon Maps and Leaflet, but with slightly different goals in mind:

Goals

• Modern, built using ES6+ syntax
• Lightweight, absolutely zero dependencies with a minified bundle of less than 20kb
• Ability to render thousands of markers, by using <canvas> rendering instead of depending on the DOM
• Wrappers for React and VueJS (Coming soon)

Using

1. Install

npm install --save npm lightning-maps

Or link directly to our build via the unpkg CDN:

<script src="https://unpkg.com/lightning-maps@0.0.1/lib/LightningMaps.min.js"></script>

2. Create a <canvas> element

<canvas id="map" width="800" height="600"></canvas>

3. Instantiate the map and add a marker

var map = new LightningMaps.Map(canvas, {
  source: function (x, y, z) {
    return `https://maps.geocod.io/tiles/base/${z}/${x}/${y}.png`;
  },
  zoom: 12,
  center: [38.86530697026126, -77.20057854052735]
});

map.addMarker(new LightningMaps.Marker([38.882666, -77.170150]))

4. Success! You now have a map

Development

Run local development build and tests

npm run dev
npm run test:watch

You can now head to http://localhost:8080/simple.html or http://localhost:8080/markers.html to test the app

Build library for distribution

npm run build