rlmcneary2 / remapgl Goto Github PK

The MapboxGL Map object has a function named remove that must be invoked to cleanup map resources. This should be done in the function returned by the useEffect hook where the Map is created.

This is the base layer control modelled on the Mapbox style layer. It will have these props:

• id: string
• layout: object
• layerType: string enum (see MB docs.)
• paint: object
• sourceType: string enum (see MB docs.)
• sourceData: any

Note - not all layer type and source combinations use all these properties. Layer components that are easier to use will be built on this component. See https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers

The props will be assembled into a layer object and shall be added to the map in a useEffect hook by map.addLayer.

The same useEffect hook shall return a function that invokes map.removeLayer and map.removeSource to cleanup the map when the Layer component is removed.

Shows the map scale.
https://docs.mapbox.com/mapbox-gl-js/api/#scalecontrol

Review the MapboxGL API for objects and options that need to be available for v1. Create a table in this issue with results.

Allows the map to go to the user's current position.
https://docs.mapbox.com/mapbox-gl-js/api/#geolocatecontrol

As pointed out here when adding controls to a map they can have a position set to indicate where they should appear. https://docs.mapbox.com/mapbox-gl-js/api/#map#addcontrol

Upgrade:

• the package
• the default CSS file name to match the package version.
• the default style to be the latest version.

Information about the API and usage will be stored in the source files. Find a tool that will export the TypeScript and comment information. Ideally that information will be [rendered to markdown, rendered to HTML].

Add a license to the package.json.
Create a copyright notice for the head of each source file.

Topics include:

• Map events
• Calculating bounds of things
• Map zoom and pan transitions
• Map styles