Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react-map-gl-draw): Remove react-map-gl-draw module #878

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Add contributors that need to publish to npm to the following:

- [nebula.gl organization](https://www.npmjs.com/settings/nebula.gl/members)
- [nebula.gl package](https://www.npmjs.com/package/nebula.gl/access)
- [react-map-gl-draw package](https://www.npmjs.com/package/react-map-gl-draw/access)

## Install and configure npmrc

Expand Down
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
<a href="https://npmjs.org/package/nebula.gl">
<img src="https://img.shields.io/npm/v/nebula.gl.svg?label=nebula.gl" alt="version" />
</a>
<a href="https://npmjs.org/package/react-map-gl-draw">
<img src="https://img.shields.io/npm/v/react-map-gl-draw.svg?label=react-map-gl-draw" alt="version" />
</a>
</p>
<p align="right">
<a href="https://npmjs.org/package/@nebula.gl/edit-modes">
Expand Down
7 changes: 0 additions & 7 deletions dev-docs/RFCs/v1.0/generic-edit-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

Create a generic `EditMode` interface that will serve as the core interface for handling user interaction and manipulating data. It will not be dependent on deck.gl, react-map-gl, or GeoJSON. This generic class will then be integrated into `EditableGeoJsonLayer` as well as the [upcoming DrawControl feature for react-map-gl](https://github.com/uber/react-map-gl/issues/734)

We will also refactor all the existing `ModeHandler` implementations of nebula to implement this interface instead so that they can be used seamlessly between `nebula.gl` and `react-map-gl-draw`.

## Motivation

There are two limitations with nebula's `ModeHandler` interface.
Expand Down Expand Up @@ -125,7 +123,6 @@ We will need a `@nebula.gl/edit-modes` module separate from the `nebula.gl` modu
- contains all the modes for editing GeoJSON (e.g. `DrawPolygonMode`)
- contains `EditMode` interface
- contains other general purpose types and classes (e.g. event types like `ClickEvent`)
- this module will be reused by `react-map-gl-draw`
- `@nebula.gl/layers`
- depends on `@nebula.gl/edit-modes` and `deck.gl`
- contains `EditableGeoJsonLayer`, a deck.gl `CompositeLayer`
Expand All @@ -135,10 +132,6 @@ We will need a `@nebula.gl/edit-modes` module separate from the `nebula.gl` modu

There will be breaking changes to refactor nebula's `ModeHandler` interface to adhere to `EditMode`'s interface. Specifics will be listed in the changelog and possibly a migration guide.

## Integration to react-map-gl-draw

`react-map-gl-draw` will follow a similar approach as `EditableGeoJsonLayer` and be responsible for the same things.

## GeoJSON

The primary implementation of `EditMode` will be for editing GeoJSON. We will expose a `GeoJsonEditMode` class with helpers for editing GeoJSON.
Expand Down
321 changes: 0 additions & 321 deletions docs/api-reference/react-map-gl-draw/react-map-gl-draw.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/interactive-examples/react-map-gl-draw-example.md

This file was deleted.

Loading