mapbox.js
A Mapbox plugin for Leaflet, a lightweight JavaScript library for traditional raster maps.
For the state-of-the-art Mapbox vector maps library, see Mapbox GL JS.
API
Managed as Markdown in API.md
, following the standards in DOCUMENTING.md
Examples
Usage
Recommended usage is via the Mapbox CDN, with code snippets available on the official documentation page
The mapbox.js
file includes the Leaflet library. Alternatively, you can use mapbox.standalone.js
, which does not include Leaflet (you will have to provide it yourself).
See the API documentation and Examples for further help.
Browserify
Usage withInstall the mapbox.js module and add it to dependencies
in package.json:
npm install mapbox.js --save
Require mapbox in your script:
// main.js require('mapbox.js'); // <-- auto-attaches to window.L
Browserify it:
browserify main.js -o bundle.js
Usage as Download
You can download a built release at the mapbox.js-bower repository.
Building
Requires node.js installed on your system.
git clone https://github.com/mapbox/mapbox.js.git cd mapbox.js npm install make
This project uses browserify to combine dependencies and installs a local copy when you run npm install
. make
will build the project in dist/
.
Tests
Test with phantomjs:
npm test
To test in a browser, run a local development server and go to /test
.
Version v0.x.x
Version v0.x.x can be accessed in the v0 branch..
Editing Icons
Requirements:
inkscape pngquant
- Make edits to
theme/images/icons.svg
. - Run
./theme/images/render.sh
to update sprites from your edits. - Add a CSS reference with the appropriate pixel coordinate if adding a new icon.
Running documentation locally
Documentation is powered by Jekyll. Running using the following command:
./jekyll.sh