Installations

npm install @mapbox/mapbox-gl-draw

Pull Requests

Open

32

Total

583

Closed

116

Merged

435

Issues

Open

183

Total

731

Closed

548

Releases

9

v1.4.3

Published on 21 Sept 2023

v1.4.2

Published on 28 Jun 2023

v1.4.1

Published on 14 Feb 2023

v1.4.0

Published on 31 Jan 2023

v1.3.0

Published on 20 May 2021

v1.2.2

Published on 25 Feb 2021

View all 9 releases

Developer

mapbox

Developer Guide

BETA

Module System

CommonJS, UMD

Min. Node Version

Typescript Support

No

Node Version

14.21.3

NPM Version

9.5.1 Statistics

958 Stars

1,448 Commits

592 Forks

133 Watching

16 Branches

631 Contributors

Updated on 26 Nov 2024

Languages

JavaScript (98.65%)

HTML (1.35%)

Total Downloads

Cumulative downloads

Total Downloads

31,037,070

Last day

-17.4%

39,921

Compared to previous day

Last week

-0.1%

222,271

Compared to previous week

Last month

7.5%

929,142

Compared to previous month

Last year

13.6%

10,751,957

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

7

hat xtend lodash.isequal @mapbox/geojson-area @mapbox/geojson-extent @mapbox/point-geometry @mapbox/geojson-normalize

Dev Dependencies

27

Versions

@mapbox/mapbox-gl-draw

Adds support for drawing and editing features on mapbox-gl.js maps. See a live example here

Requires mapbox-gl-js.

If you are developing with mapbox-gl-draw, see API.md for documentation.

Installing

npm install @mapbox/mapbox-gl-draw

Draw ships with CSS, make sure you include it in your build.

Usage in your application

JavaScript

When using modules

1import mapboxgl from 'mapbox-gl';
2import MapboxDraw from "@mapbox/mapbox-gl-draw";

When using a CDN

1<script src='https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.4.3/mapbox-gl-draw.js'></script>

CSS

When using modules

1import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css'

When using CDN

1<link rel='stylesheet' href='https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-draw/v1.4.3/mapbox-gl-draw.css' type='text/css' />

Typescript

Typescript definition files are available as part of the DefinitelyTyped package.

npm install @types/mapbox__mapbox-gl-draw

Example usage

1mapboxgl.accessToken = 'YOUR_ACCESS_TOKEN';
2
3var map = new mapboxgl.Map({
4  container: 'map',
5  style: 'mapbox://styles/mapbox/streets-v12',
6  center: [40, -74.50],
7  zoom: 9
8});
9
10var Draw = new MapboxDraw();
11
12// Map#addControl takes an optional second argument to set the position of the control.
13// If no position is specified the control defaults to `top-right`. See the docs
14// for more details: https://docs.mapbox.com/mapbox-gl-js/api/#map#addcontrol
15
16map.addControl(Draw, 'top-left');
17
18map.on('load', function() {
19  // ALL YOUR APPLICATION CODE
20});

https://www.mapbox.com/mapbox-gl-js/example/mapbox-gl-draw/

See API.md for complete reference.

Enhancements and New Interactions

For additional functionality check out our list of custom modes.

Mapbox Draw accepts functionality changes after the functionality has been proven out via a custom mode. This lets users experiment and validate their mode before entering a review process, hopefully promoting innovation. When you write a custom mode, please open a PR adding it to our list of custom modes.

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 ci
npm start & open "http://localhost:9967/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 CDN:

# make sure you are authenticated for AWS
git checkout v{x.y.z}
npm ci
npm run prepublish
aws s3 cp --recursive --acl public-read dist s3://mapbox-gl-js/plugins/mapbox-gl-draw/v{x.y.z}

Update the version number in the GL JS example.

Naming actions

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

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More