feat(MapView): rename onMapLoaded to onTilesRendered

BREAKING CHANGE: `onMapLoaded` renamed to `onTilesRendered`
react-native-maps · May 10, 2023 · 9ce06d5 · 9ce06d5
1 parent 4745f78
commit 9ce06d5
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 50 deletions.
diff --git a/android/src/main/java/com/rnmaps/maps/MapManager.java b/android/src/main/java/com/rnmaps/maps/MapManager.java
@@ -311,7 +311,7 @@ public Map getExportedCustomDirectEventTypeConstants() {
         "onIndoorLevelActivated", MapBuilder.of("registrationName", "onIndoorLevelActivated"),
         "onIndoorBuildingFocused", MapBuilder.of("registrationName", "onIndoorBuildingFocused"),
         "onDoublePress", MapBuilder.of("registrationName", "onDoublePress"),
-        "onMapLoaded", MapBuilder.of("registrationName", "onMapLoaded")
+        "onTilesRendered", MapBuilder.of("registrationName", "onTilesRendered")
     ));
 
     return map;

diff --git a/android/src/main/java/com/rnmaps/maps/MapView.java b/android/src/main/java/com/rnmaps/maps/MapView.java
@@ -404,7 +404,7 @@ public void onCameraIdle() {
     map.setOnMapLoadedCallback(new GoogleMap.OnMapLoadedCallback() {
       @Override public void onMapLoaded() {
         isMapLoaded = true;
-        manager.pushEvent(context, view, "onMapLoaded", new WritableNativeMap());
+        manager.pushEvent(context, view, "onTilesRendered", new WritableNativeMap());
         MapView.this.cacheView();
       }
     });

diff --git a/docs/mapview.md b/docs/mapview.md
@@ -77,6 +77,7 @@ To access event data, you will need to use `e.nativeEvent`. For example, `onPres
 | `onPress`                 | `{ coordinate: LatLng, position: Point }`                                | Callback that is called when user taps on the map.                                                                                                                                                                                                                                                                                    |
 | `onRegionChange`          | (`Region`, `{isGesture: boolean}`)                                       | Callback that is called continuously when the region changes, such as when a user is dragging the map. The second parameter is an object containing more details about the move. `isGesture` property indicates if the move was from the user (true) or an animation (false). **Note**: `isGesture` is supported by Google Maps only. |
 | `onRegionChangeComplete`  | (`Region`, `{isGesture: boolean}`)                                       | Callback that is called once when the region changes, such as when the user is done moving the map. The second parameter is an object containing more details about the move. `isGesture` property indicates if the move was from the user (true) or an animation (false). **Note**: `isGesture` is supported by Google Maps only.    |
+| `onTilesRendered`         |                                                                          | Callback that is called everytime all tiles have been rendered (or failed permanently) after new tiles are required. **NOTE**: for Android the callback will only be invoked once, after rendering the first time.                                                                                                                    |
 | `onUserLocationChange`    | `{ coordinate: Location }`                                               | Callback that is called when the underlying map figures our users current location (coordinate also includes isFromMockProvider value for Android API 18 and above). Make sure **showsUserLocation** is set to _true_.                                                                                                                |
 
 ## Methods

diff --git a/ios/GoogleMaps/RNMGoogleMap.h b/ios/GoogleMaps/RNMGoogleMap.h
@@ -18,62 +18,61 @@
 @interface RNMGoogleMap : GMSMapView
 
 // TODO: don't use MK region?
-@property (nonatomic, weak) RCTBridge *bridge;
+@property (nonatomic, assign) BOOL pitchEnabled;
+@property (nonatomic, assign) BOOL rotateEnabled;
+@property (nonatomic, assign) BOOL scrollDuringRotateOrZoomEnabled;
+@property (nonatomic, assign) BOOL scrollEnabled;
+@property (nonatomic, assign) BOOL showsBuildings;
+@property (nonatomic, assign) BOOL showsCompass;
+@property (nonatomic, assign) BOOL showsIndoorLevelPicker;
+@property (nonatomic, assign) BOOL showsIndoors;
+@property (nonatomic, assign) BOOL showsMyLocationButton;
+@property (nonatomic, assign) BOOL showsTraffic;
+@property (nonatomic, assign) BOOL showsUserLocation;
+@property (nonatomic, assign) BOOL zoomEnabled;
+@property (nonatomic, assign) BOOL zoomTapEnabled;
+@property (nonatomic, assign) GMSCameraPosition *cameraProp;   // Because the base class already has a "camera" prop.
 @property (nonatomic, assign) MKCoordinateRegion initialRegion;
 @property (nonatomic, assign) MKCoordinateRegion region;
-@property (nonatomic, assign) GMSCameraPosition *cameraProp;   // Because the base class already has a "camera" prop.
-@property (nonatomic, strong) GMSCameraPosition *initialCamera;
 @property (nonatomic, assign) NSString *customMapStyleString;
-@property (nonatomic, assign) UIEdgeInsets mapPadding;
+@property (nonatomic, assign) NSString *kmlSrc;
 @property (nonatomic, assign) NSString *paddingAdjustmentBehaviorString;
-@property (nonatomic, copy) RCTBubblingEventBlock onMapReady;
-@property (nonatomic, copy) RCTBubblingEventBlock onMapLoaded;
+@property (nonatomic, assign) UIEdgeInsets mapPadding;
+@property (nonatomic, copy) RCTBubblingEventBlock onChange;
 @property (nonatomic, copy) RCTBubblingEventBlock onKmlReady;
-@property (nonatomic, copy) RCTBubblingEventBlock onPress;
 @property (nonatomic, copy) RCTBubblingEventBlock onLongPress;
-@property (nonatomic, copy) RCTBubblingEventBlock onPanDrag;
-@property (nonatomic, copy) RCTBubblingEventBlock onUserLocationChange;
+@property (nonatomic, copy) RCTBubblingEventBlock onMapReady;
 @property (nonatomic, copy) RCTBubblingEventBlock onMarkerPress;
-@property (nonatomic, copy) RCTBubblingEventBlock onChange;
+@property (nonatomic, copy) RCTBubblingEventBlock onPanDrag;
 @property (nonatomic, copy) RCTBubblingEventBlock onPoiClick;
+@property (nonatomic, copy) RCTBubblingEventBlock onPress;
+@property (nonatomic, copy) RCTBubblingEventBlock onTilesRendered;
+@property (nonatomic, copy) RCTBubblingEventBlock onUserLocationChange;
+@property (nonatomic, copy) RCTDirectEventBlock onIndoorBuildingFocused;
+@property (nonatomic, copy) RCTDirectEventBlock onIndoorLevelActivated;
 @property (nonatomic, copy) RCTDirectEventBlock onRegionChange;
 @property (nonatomic, copy) RCTDirectEventBlock onRegionChangeComplete;
-@property (nonatomic, copy) RCTDirectEventBlock onIndoorLevelActivated;
-@property (nonatomic, copy) RCTDirectEventBlock onIndoorBuildingFocused;
+@property (nonatomic, strong) GMSCameraPosition *initialCamera;
+@property (nonatomic, strong) NSMutableArray *circles;
+@property (nonatomic, strong) NSMutableArray *heatmaps;
 @property (nonatomic, strong) NSMutableArray *markers;
+@property (nonatomic, strong) NSMutableArray *overlays;
 @property (nonatomic, strong) NSMutableArray *polygons;
 @property (nonatomic, strong) NSMutableArray *polylines;
-@property (nonatomic, strong) NSMutableArray *circles;
-@property (nonatomic, strong) NSMutableArray *heatmaps;
 @property (nonatomic, strong) NSMutableArray *tiles;
-@property (nonatomic, strong) NSMutableArray *overlays;
-
-@property (nonatomic, assign) BOOL showsBuildings;
-@property (nonatomic, assign) BOOL showsTraffic;
-@property (nonatomic, assign) BOOL showsCompass;
-@property (nonatomic, assign) BOOL scrollEnabled;
-@property (nonatomic, assign) BOOL zoomEnabled;
-@property (nonatomic, assign) BOOL rotateEnabled;
-@property (nonatomic, assign) BOOL scrollDuringRotateOrZoomEnabled;
-@property (nonatomic, assign) BOOL pitchEnabled;
-@property (nonatomic, assign) BOOL zoomTapEnabled;
-@property (nonatomic, assign) BOOL showsUserLocation;
-@property (nonatomic, assign) BOOL showsMyLocationButton;
-@property (nonatomic, assign) BOOL showsIndoors;
-@property (nonatomic, assign) BOOL showsIndoorLevelPicker;
-@property (nonatomic, assign) NSString *kmlSrc;
+@property (nonatomic, weak) RCTBridge *bridge;
 
-- (void)didPrepareMap;
-- (void)mapViewDidFinishTileRendering;
 - (BOOL)didTapMarker:(GMSMarker *)marker;
-- (void)didTapPolyline:(GMSPolyline *)polyline;
-- (void)didTapPolygon:(GMSPolygon *)polygon;
-- (void)didTapAtCoordinate:(CLLocationCoordinate2D)coordinate;
-- (void)didLongPressAtCoordinate:(CLLocationCoordinate2D)coordinate;
+- (NSArray *)getMapBoundaries;
 - (void)didChangeCameraPosition:(GMSCameraPosition *)position isGesture:(BOOL)isGesture;
-- (void)idleAtCameraPosition:(GMSCameraPosition *)position isGesture:(BOOL)isGesture;
+- (void)didLongPressAtCoordinate:(CLLocationCoordinate2D)coordinate;
+- (void)didPrepareMap;
+- (void)didTapAtCoordinate:(CLLocationCoordinate2D)coordinate;
 - (void)didTapPOIWithPlaceID:(NSString *)placeID name:(NSString *) name location:(CLLocationCoordinate2D) location;
-- (NSArray *)getMapBoundaries;
+- (void)didTapPolygon:(GMSPolygon *)polygon;
+- (void)didTapPolyline:(GMSPolyline *)polyline;
+- (void)idleAtCameraPosition:(GMSCameraPosition *)position isGesture:(BOOL)isGesture;
+- (void)mapViewDidFinishTileRendering;
 
 + (MKCoordinateRegion)makeGMSCameraPositionFromMap:(GMSMapView *)map andGMSCameraPosition:(GMSCameraPosition *)position;
 + (GMSCameraPosition*)makeGMSCameraPositionFromMap:(GMSMapView *)map andMKCoordinateRegion:(MKCoordinateRegion)region;

diff --git a/ios/GoogleMaps/RNMGoogleMap.m b/ios/GoogleMaps/RNMGoogleMap.m
@@ -330,7 +330,7 @@ - (void)didPrepareMap {
 }
 
 - (void)mapViewDidFinishTileRendering {
-  if (self.onMapLoaded) self.onMapLoaded(@{});
+  if (self.onTilesRendered) self.onTilesRendered(@{});
 }
 
 - (BOOL)didTapMarker:(GMSMarker *)marker {

diff --git a/ios/GoogleMaps/RNMGoogleMapManager.m b/ios/GoogleMaps/RNMGoogleMapManager.m
@@ -81,14 +81,14 @@ - (UIView *)view
 RCT_EXPORT_VIEW_PROPERTY(onIndoorLevelActivated, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onKmlReady, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onLongPress, RCTBubblingEventBlock)
-RCT_EXPORT_VIEW_PROPERTY(onMapLoaded, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onMapReady, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onMarkerPress, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPanDrag, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPoiClick, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPress, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onRegionChange, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onRegionChangeComplete, RCTDirectEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onTilesRendered, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onUserLocationChange, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(pitchEnabled, BOOL)
 RCT_EXPORT_VIEW_PROPERTY(region, MKCoordinateRegion)

diff --git a/src/MapView.tsx b/src/MapView.tsx
@@ -317,14 +317,6 @@ export type MapViewProps = ViewProps & {
    */
   onLongPress?: (event: LongPressEvent) => void;
 
-  /**
-   * Callback that is called when the map has finished rendering all tiles.
-   *
-   * @platform iOS: Google Maps only
-   * @platform Android: Supported
-   */
-  onMapLoaded?: (event: NativeSyntheticEvent<{}>) => void;
-
   /**
    * Callback that is called once the map is ready.
    *
@@ -432,6 +424,14 @@ export type MapViewProps = ViewProps & {
    */
   onRegionChangeComplete?: (region: Region, details: Details) => void;
 
+  /**
+   * Callback that is called when the map has finished rendering all tiles.
+   *
+   * @platform iOS: Supported
+   * @platform Android: Supported
+   */
+  onTilesRendered?: (event: NativeSyntheticEvent<{}>) => void;
+
   /**
    * Callback that is called when the underlying map figures our users current location
    * (coordinate also includes isFromMockProvider value for Android API 18 and above).