From 1fc80443841cbfba4b2e9c9c39fdff49923d8fc3 Mon Sep 17 00:00:00 2001 From: Anurag Kyal Date: Fri, 5 Jun 2020 13:21:34 -0700 Subject: [PATCH] [geolocate] better docs for auto prop (#1125) --- docs/api-reference/geolocate-control.md | 2 +- docs/whats-new.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api-reference/geolocate-control.md b/docs/api-reference/geolocate-control.md index 0d6dec61..06d2912c 100644 --- a/docs/api-reference/geolocate-control.md +++ b/docs/api-reference/geolocate-control.md @@ -83,7 +83,7 @@ Label applied to the Geolocate control button. - default: `false` -Auto trigger geolocate on successful mounting of component +Programmatically triggers geolocate when set to true. Initializing the component with true triggers inside `componentDidMount` where as changing to true at a later point triggers inside `componentDidUpdate`. Initally setting as or changing to false has no effect. ## Styling diff --git a/docs/whats-new.md b/docs/whats-new.md index 90ae9f69..a2de5415 100644 --- a/docs/whats-new.md +++ b/docs/whats-new.md @@ -8,7 +8,7 @@ Release date: Jan 6, 2020 - **New Components**: [`ScaleControl`](/docs/api-reference/scale-control.md) - **NavigationControl**: new `label` prop -- **GeolocateControl**: new `label`, `onGeolocate` props +- **GeolocateControl**: new `label`, `onGeolocate`, `auto` props - **New Export**: `WebMercatorViewport` is re-exported from the `viewport-mercator-project` library for ease of use. It's recommended to import it from `react-map-gl` instead to avoid future dependency change. - **New Example**: [Clusters](https://uber.github.io/react-map-gl/examples/clusters) @@ -28,13 +28,13 @@ Release date: May 31, 2019 ### What's Changed -The only change between the 5.0 release and the latest 4.1 release is Mapbox GL JS v1.0. By using this version, you opt into Mapbox's new pricing model, which bills per map load instead of map views. 5.0.x and 4.1.x will continue to update in parallel with otherwise identical features until November 2019 when Mapbox moves all users of 0.xx to a new pricing scheme. For more details, see mapbox's [changelog](https://github.com/mapbox/mapbox-gl-js/releases/tag/v1.0.0) and [blog post](https://blog.mapbox.com/new-pricing-46b7c26166e7). +The only change between the 5.0 release and the latest 4.1 release is Mapbox GL JS v1.0. By using this version, you opt into Mapbox's new pricing model, which bills per map load instead of map views. 5.0.x and 4.1.x will continue to update in parallel with otherwise identical features until November 2019 when Mapbox moves all users of 0.xx to a new pricing scheme. For more details, see mapbox's [changelog](https://github.com/mapbox/mapbox-gl-js/releases/tag/v1.0.0) and [blog post](https://blog.mapbox.com/new-pricing-46b7c26166e7). Alongside Mapbox GL JS's new milestone, we have relaxed the `mapbox-gl` dependency from locking minor release (`~0.53.0`) to major release (`^1.0.0`). This will allow developers to upgrade faster without waiting for a new release from react-map-gl. ## react-map-gl v4.1 -Release date: Mar 14, 2019 +Release date: Mar 14, 2019 ### Highlights