# mapbox-gl-draw

> A drawing component for Mapbox GL JS

Latest version **0.16.0** (published 2016-11-18) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install mapbox-gl-draw
pnpm add mapbox-gl-draw
yarn add mapbox-gl-draw
bun add mapbox-gl-draw
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.16.0 |
| Published | 2016-11-18 |
| First published | 2015-12-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1092 |
| Author | mapbox |
| Maintainers | 1ec5, aaronlidman, ajashton, ansis, apendleton, bergwerkgis, bhousel, bsudekum, camilleanne, dnomadb, dthompson, emilymcafee, flippmoke, freenerd, ghoshkaj, gretacb, ian29, ianshward, ingalls, jfirebaugh, jrpruit1, karenzshea, kelvinabrokwa, kkaefer, lbud, lucaswoj, lxbarth, lyzidiamond, mapbox-admin, mateov, mcwhittemore, miccolis, mikemorris, morganherlocker, mourner, mtirwin, nickidlugash, rclark, samanbb, sbma44, scothis, sgillies, springmeyer, themarex, tmcw, tristen, willwhite, yhahn |
| Keywords | webgl, mapbox, draw, drawing |

## Links

- npm: https://www.npmjs.com/package/mapbox-gl-draw
- Repository: https://github.com/mapbox/mapbox-gl-draw
- Issues: https://github.com/mapbox/mapbox-gl-draw/issues
- npm.io page: https://npm.io/package/mapbox-gl-draw

## Dependencies (8)

- [hat](https://npm.io/package/hat.md) 0.0.3
- [xtend](https://npm.io/package/xtend.md) ^4.0.1
- [geojsonhint](https://npm.io/package/geojsonhint.md) ^2.0.0beta
- [geojson-area](https://npm.io/package/geojson-area.md) ^0.2.1
- [geojson-extent](https://npm.io/package/geojson-extent.md) ^0.3.2
- [lodash.isequal](https://npm.io/package/lodash.isequal.md) ^4.2.0
- [point-geometry](https://npm.io/package/point-geometry.md) 0.0.0
- [geojson-normalize](https://npm.io/package/geojson-normalize.md) 0.0.1

## Recent versions

- 0.16.0 (latest) — 2016-11-18
- 0.11.9 (next) — 2016-07-08
- 0.15.0 — 2016-11-17
- 0.14.0 — 2016-11-17
- 0.13.2 — 2016-10-28
- 0.13.1 — 2016-10-21
- 0.13.0 — 2016-10-20
- 0.12.2 — 2016-10-14
- 0.12.1 — 2016-10-05
- 0.12.0 — 2016-10-05
- 0.11.21 — 2016-09-30
- 0.11.20 — 2016-09-28
- 0.11.19 — 2016-09-01
- 0.11.18 — 2016-08-31
- 0.11.17 — 2016-08-31
- … 79 more at https://npm.io/package/mapbox-gl-draw/versions

## README

# mapbox-gl-draw.js

Adds support for drawing and editing features on [mapbox-gl.js](https://www.mapbox.com/mapbox-gl-js/) maps.

[![Circle CI](https://circleci.com/gh/mapbox/mapbox-gl-draw/tree/master.svg?style=svg)](https://circleci.com/gh/mapbox/gl-draw/tree/master)

**Requires [mapbox-gl-js@0.27.0](https://github.com/mapbox/mapbox-gl-js/blob/master/CHANGELOG.md#0270-november-11-2016) or higher.**

### Installing

```
npm install mapbox-gl-draw
```

Draw ships with CSS, make sure you include it in your build. It can be found on our CDN or at `require('mapbox-gl-draw/dist/mapbox-gl-draw.css')`.

```html
<link rel='stylesheet' href='https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v0.14.0/mapbox-gl-draw.css' type='text/css' />
```

### Usage in your application

**When using modules**

```js
var mapboxgl = require('mapbox-gl');
var MapboxDraw = require('mapbox-gl-draw');
```

**When using a CDN**

```html
<script src='https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v0.14.0/mapbox-gl-draw.js'></script>
```

**Example setup**

```js
mapboxgl.accessToken = 'YOUR_ACCESS_TOKEN';

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

var Draw = new MapboxDraw();

map.addControl(Draw)
```

### See [API.md](https://github.com/mapbox/mapbox-gl-draw/blob/master/API.md) for complete reference.

### Developing and testing

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

```
git clone git@github.com:mapbox/mapbox-gl-draw.git
npm install
npm start & open http://localhost:9966/debug/?access_token=<token>
```

### Testing

```
npm run test
```

### Publishing

To github and npm

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

To add to CDN add the js and css files from the `dist` folder to [mapbox-gl-plugins](https://github.com/mapbox/mapbox-gl-plugins/tree/master/plugins/mapbox-gl-draw).

### Naming actions

We're trying to follow standards when naming things. Here is a collection of links where we look for inspriation.

- http://turfjs.org/docs/
- http://toblerity.org/shapely/manual.html

---
_Source: https://npm.io/package/mapbox-gl-draw · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._