archive-gh-me/react-map-gl
1
0
Fork 0
mirror of https://github.com/visgl/react-map-gl.git synced 2026-01-18 15:54:22 +00:00
Code Issues Projects Releases Wiki Activity

Clarify ref migration in upgrade guide (#1356)

Browse Source
This commit is contained in:
Xiaoji Chen 2021-02-16 10:51:07 -08:00 committed by Xiaoji Chen
parent 59d7f7379a
commit c5501f56b3
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/upgrade-guide.md
View File

@ -16,6 +16,10 @@ const CONTROLLER_OPTS = {
<MapGL {...CONTROLLER_OPTS} ... />
```
- `Source` and `Layer` components no longer expose imperative methods via `ref` as part of the migration to functional components. This is to comply with the pattern recommended by the latest React.
+ If you used to call `sourceRef.getSource()`, it can be replaced with `mapRef().getMap().getSource(sourceId)`.
+ If you used to call `layerRef.getLayer()`, it can be replaced with `mapRef().getMap().getLayer(layerId)`.
## Upgrading to v6
- A valid Mapbox access token is always required.