@mapbox/mapbox-gl-traffic

Mapbox GL JS plugin for enabling/disabling traffic

Stats

StarsIssuesVersionUpdatedCreatedSize
@mapbox/mapbox-gl-traffic
4971.0.24 years ago4 years agoMinified + gzip package size for @mapbox/mapbox-gl-traffic in KB

Readme

Mapbox GL Traffic Build Status npm

Add a traffic toggle control to Mapbox GL JS.

:globe_with_meridians: Check the demo

demo

Usage

mapbox-gl-traffic is a Mapbox GL JS plugin that you can easily add on top of your map. Check index.html for a complete example.

Make sure to include the CSS and JS files.

When using NPM

Check how to use Mapbox GL JS in a module bundler.

npm install --save mapbox-gl @mapbox/mapbox-gl-traffic
const mapboxgl = require('mapbox-gl')
const MapboxTraffic = require('@mapbox/mapbox-gl-traffic');
const map = new mapboxgl.Map({
    container: 'map',
    style: 'mapbox://styles/mapbox/traffic-night-v2',
    center: [-77.0259, 38.9010],
    zoom: 9
});
map.addControl(new MapboxTraffic());

Examples

API

MapboxTraffic

Create a new Mapbox GL JS plugin that allows you to hide and show traffic layers in your map and an optional toggle button.

Parameters

  • options object Options to configure the plugin.
    • options.showTraffic boolean Show or hide traffic overlay by default. (optional, default false)
    • options.showTrafficButton boolean Show a toggle button to turn traffic on and off. (optional, default true)
    • options.trafficSource RegExp The traffic source regex used to determine whether a layer displays traffic or not. (optional, default /mapbox-traffic-v\d/)

Develop

Run the linter and watch for changes to rebuild with browserify.

npm install
npm run test
npm run watch

Create a minified standalone build.

npm install
npm run build

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.