Skip to content

Commit

Permalink
Update to latest GL-JS (#5)
Browse files Browse the repository at this point in the history
* Update deps and docs
* Update to v1 of GL-JS and remove unnecessary node deps
* Fix Map icon
* Update gl-js to v1.1.1
  • Loading branch information
Asheem Mamoowala authored Jul 23, 2019
1 parent 724d037 commit 91d9e5a
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 27 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ const map = new mapboxgl.Map({
center: [-77.0259, 38.9010],
zoom: 9
});
map.addControl(new MapboxTraffic());
map.on('load', () => {
map.addControl(new MapboxTraffic());
});
```

## Examples
Expand All @@ -45,17 +47,23 @@ map.addControl(new MapboxTraffic());

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

- [MapboxTraffic](#mapboxtraffic)
- [Parameters](#parameters)
- [toggleTraffic](#toggletraffic)

### MapboxTraffic

Create a new [Mapbox GL JS plugin](https://www.mapbox.com/blog/build-mapbox-gl-js-plugins/) that allows you to hide and show
traffic layers in your map and an optional toggle button.

**Parameters**
#### Parameters

- `options` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options to configure the plugin.
- `options.showTraffic` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Show or hide traffic overlay by default. (optional, default `false`)
- `options.showTrafficButton` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Show a toggle button to turn traffic on and off. (optional, default `true`)
- `options.trafficSource` **[RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** The traffic source regex used to determine whether a layer displays traffic or not. (optional, default `/mapbox-traffic-v\d/`)
- `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options to configure the plugin.
- `options.showTraffic` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Show or hide traffic overlay by default. (optional, default `false`)
- `options.showTrafficButton` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Show a toggle button to turn traffic on and off. (optional, default `true`)
- `options.trafficSource` **[RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** The traffic source regex used to determine whether a layer displays traffic or not. (optional, default `/mapbox-traffic-v\d/`)

#### toggleTraffic

Expand Down
4 changes: 2 additions & 2 deletions examples/mapbox-dark.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions examples/mapbox-light.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions examples/mapbox-outdoors.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions examples/mapbox-streets.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.37.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions examples/traffic-day.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.30.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.30.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions examples/traffic-night.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.30.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.30.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='../mapbox-gl-traffic.js'></script>
<link href='../mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset='utf-8' />
<title>Mapbox GL Traffic</title>
<meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.31.0/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.31.0/mapbox-gl.css' rel='stylesheet' />
<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v1.1.1/mapbox-gl.css' rel='stylesheet' />
<script src='mapbox-gl-traffic.js'></script>
<link href='mapbox-gl-traffic.css' rel='stylesheet' />
<style>
Expand Down
2 changes: 1 addition & 1 deletion mapbox-gl-traffic.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 3 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,12 @@
},
"homepage": "https://github.com/mapbox/mapbox-gl-traffic#readme",
"devDependencies": {
"browserify": "^11.2.0",
"documentation": "^4.0.0-beta.18",
"documentation": "^11.0.0",
"eslint": "^2.8.0",
"eslint-config-mourner": "^2.0.1",
"uglify-js": "^2.4.24",
"watchify": "^3.8.0"
"eslint-config-mourner": "^2.0.1"
},
"peerDependencies": {
"mapbox-gl": "^0.29.0"
"mapbox-gl": ">=0.29.0 <2.0.0"
},
"eslintConfig": {
"parserOptions": {
Expand Down

0 comments on commit 91d9e5a

Please sign in to comment.