@maplibre/maplibre-react-native 8.6.0-beta.1 → 9.0.0

package/javascript/components/MapView.js

@@ -21,8 +21,8 @@ import {
 } from 'react-native';
 import {debounce} from 'debounce';
 
-const MapboxGL = NativeModules.MGLModule;
-if (MapboxGL == null) {
+const MapLibreGL = NativeModules.MGLModule;
+if (MapLibreGL == null) {
   console.error(
     'Native part of Mapbox React Native libraries were not registered properly, double check our native installation guides.',
   );
@@ -36,10 +36,10 @@ const styles = StyleSheet.create({
   matchParent: {flex: 1},
 });
 
-const defaultStyleURL = MapboxGL.StyleURL.Street;
+const defaultStyleURL = MapLibreGL.StyleURL.Street;
 
 /**
- * MapView backed by Mapbox Native GL
+ * MapView backed by MapLibre GL Native
  */
 class MapView extends NativeBridgeComponent(React.Component) {
   static propTypes = {
@@ -59,7 +59,7 @@ class MapView extends NativeBridgeComponent(React.Component) {
     style: PropTypes.any,
 
     /**
-     * Style URL for map - notice, if non is set it _will_ default to `MapboxGL.StyleURL.Street`
+     * Style URL for map - notice, if non is set it _will_ default to `MapLibreGL.StyleURL.Street`
      */
     styleURL: PropTypes.string,
 
@@ -106,13 +106,10 @@ class MapView extends NativeBridgeComponent(React.Component) {
     rotateEnabled: PropTypes.bool,
 
     /**
-     * The Mapbox terms of service, which governs the use of Mapbox-hosted vector tiles and styles,
-     * [requires](https://www.mapbox.com/help/how-attribution-works/) these copyright notices to accompany any map that features Mapbox-designed styles, OpenStreetMap data, or other Mapbox data such as satellite or terrain data.
-     * If that applies to this map view, do not hide this view or remove any notices from it.
-     *
-     * If this view is hidden, you must implement this setting elsewhere in your app. See our website for [Android](https://www.mapbox.com/android-docs/map-sdk/overview/#telemetry-opt-out) and [iOS](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) for implementation details.
-     *
      * Enable/Disable attribution on map.
+     *
+     * This must be enabled for Mapbox-hosted tiles and styles. Please refer to the Mapbox Terms of Service.
+     * Other providers do not require this.
      */
     attributionEnabled: PropTypes.bool,
 
@@ -269,7 +266,7 @@ class MapView extends NativeBridgeComponent(React.Component) {
     pitchEnabled: true,
     rotateEnabled: true,
     attributionEnabled: true,
-    logoEnabled: true,
+    logoEnabled: false,
     surfaceView: false,
     regionWillChangeDebounceTime: 10,
     regionDidChangeDebounceTime: 500,
@@ -326,46 +323,46 @@ class MapView extends NativeBridgeComponent(React.Component) {
       const events = [];
 
       if (props.onRegionWillChange) {
-        events.push(MapboxGL.EventTypes.RegionWillChange);
+        events.push(MapLibreGL.EventTypes.RegionWillChange);
       }
       if (props.onRegionIsChanging) {
-        events.push(MapboxGL.EventTypes.RegionIsChanging);
+        events.push(MapLibreGL.EventTypes.RegionIsChanging);
       }
       if (props.onRegionDidChange) {
-        events.push(MapboxGL.EventTypes.RegionDidChange);
+        events.push(MapLibreGL.EventTypes.RegionDidChange);
       }
       if (props.onUserLocationUpdate) {
-        events.push(MapboxGL.EventTypes.UserLocationUpdated);
+        events.push(MapLibreGL.EventTypes.UserLocationUpdated);
       }
       if (props.onWillStartLoadingMap) {
-        events.push(MapboxGL.EventTypes.WillStartLoadingMap);
+        events.push(MapLibreGL.EventTypes.WillStartLoadingMap);
       }
       if (props.onDidFinishLoadingMap) {
-        events.push(MapboxGL.EventTypes.DidFinishLoadingMap);
+        events.push(MapLibreGL.EventTypes.DidFinishLoadingMap);
       }
       if (props.onDidFailLoadingMap) {
-        events.push(MapboxGL.EventTypes.DidFailLoadingMap);
+        events.push(MapLibreGL.EventTypes.DidFailLoadingMap);
       }
       if (props.onWillStartRenderingFrame) {
-        events.push(MapboxGL.EventTypes.WillStartRenderingFrame);
+        events.push(MapLibreGL.EventTypes.WillStartRenderingFrame);
       }
       if (props.onDidFinishRenderingFrame) {
-        events.push(MapboxGL.EventTypes.DidFinishRenderingFrame);
+        events.push(MapLibreGL.EventTypes.DidFinishRenderingFrame);
       }
       if (props.onDidFinishRenderingFrameFully) {
-        events.push(MapboxGL.EventTypes.DidFinishRenderingFrameFully);
+        events.push(MapLibreGL.EventTypes.DidFinishRenderingFrameFully);
       }
       if (props.onWillStartRenderingMap) {
-        events.push(MapboxGL.EventTypes.WillStartRenderingMap);
+        events.push(MapLibreGL.EventTypes.WillStartRenderingMap);
       }
       if (props.onDidFinishRenderingMap) {
-        events.push(MapboxGL.EventTypes.DidFinishRenderingMap);
+        events.push(MapLibreGL.EventTypes.DidFinishRenderingMap);
       }
       if (props.onDidFinishRenderingMapFully) {
-        events.push(MapboxGL.EventTypes.DidFinishRenderingMapFully);
+        events.push(MapLibreGL.EventTypes.DidFinishRenderingMapFully);
       }
       if (props.onDidFinishLoadingStyle) {
-        events.push(MapboxGL.EventTypes.DidFinishLoadingStyle);
+        events.push(MapLibreGL.EventTypes.DidFinishLoadingStyle);
       }
 
       this._runNativeCommand(
@@ -564,7 +561,7 @@ class MapView extends NativeBridgeComponent(React.Component) {
 
   _createStopConfig(config = {}) {
     const stopConfig = {
-      mode: isNumber(config.mode) ? config.mode : MapboxGL.CameraModes.Ease,
+      mode: isNumber(config.mode) ? config.mode : MapLibreGL.CameraModes.Ease,
       pitch: config.pitch,
       heading: config.heading,
       duration: config.duration || 2000,
@@ -623,54 +620,54 @@ class MapView extends NativeBridgeComponent(React.Component) {
     let propName = '';
 
     switch (type) {
-      case MapboxGL.EventTypes.RegionWillChange:
+      case MapLibreGL.EventTypes.RegionWillChange:
         if (regionWillChangeDebounceTime > 0) {
           this._onDebouncedRegionWillChange(payload);
         } else {
           propName = 'onRegionWillChange';
         }
         break;
-      case MapboxGL.EventTypes.RegionIsChanging:
+      case MapLibreGL.EventTypes.RegionIsChanging:
         propName = 'onRegionIsChanging';
         break;
-      case MapboxGL.EventTypes.RegionDidChange:
+      case MapLibreGL.EventTypes.RegionDidChange:
         if (regionDidChangeDebounceTime > 0) {
           this._onDebouncedRegionDidChange(payload);
         } else {
           propName = 'onRegionDidChange';
         }
         break;
-      case MapboxGL.EventTypes.UserLocationUpdated:
+      case MapLibreGL.EventTypes.UserLocationUpdated:
         propName = 'onUserLocationUpdate';
         break;
-      case MapboxGL.EventTypes.WillStartLoadingMap:
+      case MapLibreGL.EventTypes.WillStartLoadingMap:
         propName = 'onWillStartLoadingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishLoadingMap:
+      case MapLibreGL.EventTypes.DidFinishLoadingMap:
         propName = 'onDidFinishLoadingMap';
         break;
-      case MapboxGL.EventTypes.DidFailLoadingMap:
+      case MapLibreGL.EventTypes.DidFailLoadingMap:
         propName = 'onDidFailLoadingMap';
         break;
-      case MapboxGL.EventTypes.WillStartRenderingFrame:
+      case MapLibreGL.EventTypes.WillStartRenderingFrame:
         propName = 'onWillStartRenderingFrame';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingFrame:
+      case MapLibreGL.EventTypes.DidFinishRenderingFrame:
         propName = 'onDidFinishRenderingFrame';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingFrameFully:
+      case MapLibreGL.EventTypes.DidFinishRenderingFrameFully:
         propName = 'onDidFinishRenderingFrameFully';
         break;
-      case MapboxGL.EventTypes.WillStartRenderingMap:
+      case MapLibreGL.EventTypes.WillStartRenderingMap:
         propName = 'onWillStartRenderingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingMap:
+      case MapLibreGL.EventTypes.DidFinishRenderingMap:
         propName = 'onDidFinishRenderingMap';
         break;
-      case MapboxGL.EventTypes.DidFinishRenderingMapFully:
+      case MapLibreGL.EventTypes.DidFinishRenderingMapFully:
         propName = 'onDidFinishRenderingMapFully';
         break;
-      case MapboxGL.EventTypes.DidFinishLoadingStyle:
+      case MapLibreGL.EventTypes.DidFinishLoadingStyle:
         propName = 'onDidFinishLoadingStyle';
         break;
       default:

package/javascript/components/RasterLayer.js

@@ -7,7 +7,7 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import {NativeModules, requireNativeComponent} from 'react-native';
 
-const MapboxGL = NativeModules.MGLModule;
+const MapLibreGL = NativeModules.MGLModule;
 
 export const NATIVE_MODULE_NAME = 'RCTMGLRasterLayer';
 
@@ -72,7 +72,7 @@ class RasterLayer extends AbstractLayer {
   };
 
   static defaultProps = {
-    sourceID: MapboxGL.StyleSource.DefaultSourceID,
+    sourceID: MapLibreGL.StyleSource.DefaultSourceID,
   };
 
   render() {

package/javascript/components/RasterSource.js

@@ -6,7 +6,7 @@ import PropTypes from 'prop-types';
 import {NativeModules, requireNativeComponent} from 'react-native';
 import React from 'react';
 
-const MapboxGL = NativeModules.MGLModule;
+const MapLibreGL = NativeModules.MGLModule;
 
 export const NATIVE_MODULE_NAME = 'RCTMGLRasterSource';
 
@@ -72,7 +72,7 @@ class RasterSource extends AbstractSource {
   };
 
   static defaultProps = {
-    id: MapboxGL.StyleSource.DefaultSourceID,
+    id: MapLibreGL.StyleSource.DefaultSourceID,
   };
 
   constructor(props) {

package/javascript/components/ShapeSource.js

@@ -15,7 +15,7 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import {NativeModules, requireNativeComponent} from 'react-native';
 
-const MapboxGL = NativeModules.MGLModule;
+const MapLibreGL = NativeModules.MGLModule;
 
 export const NATIVE_MODULE_NAME = 'RCTMGLShapeSource';
 
@@ -120,7 +120,7 @@ class ShapeSource extends NativeBridgeComponent(AbstractSource) {
   };
 
   static defaultProps = {
-    id: MapboxGL.StyleSource.DefaultSourceID,
+    id: MapLibreGL.StyleSource.DefaultSourceID,
   };
 
   constructor(props) {

package/javascript/components/Style.js

@@ -193,8 +193,8 @@ function asSourceComponent(id, source) {
 }
 
 /**
- * Style is a component that automatically adds sources / layers to the map using Mapbox GL Style Spec.
- * Only [`sources`](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources) & [`layers`](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) are supported.
+ * Style is a component that automatically adds sources / layers to the map using MapLibre Style Spec.
+ * Only [`sources`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) & [`layers`](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/) are supported.
  * Other fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will be mentioned under https://github.com/maplibre/maplibre-react-native/tree/main/docs.
  *
  * TODO: Maintainer forking this project does not understand the above comment regarding what is supported.
@@ -256,7 +256,7 @@ const Style = props => {
 
 Style.propTypes = {
   /**
-   * A JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON.
+   * A JSON object conforming to the schema described in the MapLibre Style Specification, or a URL to such JSON.
    */
   json: PropTypes.any,
 };

package/javascript/components/SymbolLayer.js

@@ -7,7 +7,7 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import {View, NativeModules, requireNativeComponent} from 'react-native';
 
-const MapboxGL = NativeModules.MGLModule;
+const MapLibreGL = NativeModules.MGLModule;
 
 export const NATIVE_MODULE_NAME = 'RCTMGLSymbolLayer';
 
@@ -75,7 +75,7 @@ class SymbolLayer extends AbstractLayer {
   };
 
   static defaultProps = {
-    sourceID: MapboxGL.StyleSource.DefaultSourceID,
+    sourceID: MapLibreGL.StyleSource.DefaultSourceID,
   };
 
   _shouldSnapshot() {

package/javascript/components/UserLocation.js

@@ -104,6 +104,8 @@ class UserLocation extends React.Component {
 
     /**
      * Custom location icon of type mapbox-gl-native components
+     *
+     * NOTE: Forking maintainer does not understand the above comment.
      */
     children: PropTypes.any,
   };

package/javascript/components/VectorSource.js

@@ -14,7 +14,7 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import {NativeModules, requireNativeComponent} from 'react-native';
 
-const MapboxGL = NativeModules.MGLModule;
+const MapLibreGL = NativeModules.MGLModule;
 
 export const NATIVE_MODULE_NAME = 'RCTMGLVectorSource';
 
@@ -94,7 +94,7 @@ class VectorSource extends NativeBridgeComponent(AbstractSource) {
   };
 
   static defaultProps = {
-    id: MapboxGL.StyleSource.DefaultSourceID,
+    id: MapLibreGL.StyleSource.DefaultSourceID,
   };
 
   constructor(props) {

package/javascript/index.js

@@ -32,16 +32,12 @@ import AnimatedRouteCoordinatesArray from './utils/animated/AnimatedRouteCoordin
 import Style from './components/Style';
 import Logger from './utils/Logger';
 
-import {
-  Animated as RNAnimated,
-  NativeModules,
-  PermissionsAndroid,
-} from 'react-native';
+import {NativeModules, PermissionsAndroid} from 'react-native';
 
-const MapboxGL = {...NativeModules.MGLModule};
+const MapLibreGL = {...NativeModules.MGLModule};
 
 // static methods
-MapboxGL.requestAndroidLocationPermissions = async function () {
+MapLibreGL.requestAndroidLocationPermissions = async function () {
   if (isAndroid()) {
     const res = await PermissionsAndroid.requestMultiple([
       PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION,
@@ -65,56 +61,56 @@ MapboxGL.requestAndroidLocationPermissions = async function () {
   throw new Error('You should only call this method on Android!');
 };
 
-MapboxGL.UserTrackingModes = Camera.UserTrackingModes;
+MapLibreGL.UserTrackingModes = Camera.UserTrackingModes;
 
 // components
-MapboxGL.MapView = MapView;
-MapboxGL.Light = Light;
-MapboxGL.PointAnnotation = PointAnnotation;
-MapboxGL.Callout = Callout;
-MapboxGL.UserLocation = UserLocation;
-MapboxGL.Camera = Camera;
-MapboxGL.Style = Style;
+MapLibreGL.MapView = MapView;
+MapLibreGL.Light = Light;
+MapLibreGL.PointAnnotation = PointAnnotation;
+MapLibreGL.Callout = Callout;
+MapLibreGL.UserLocation = UserLocation;
+MapLibreGL.Camera = Camera;
+MapLibreGL.Style = Style;
 
 // annotations
-MapboxGL.Annotation = Annotation;
-MapboxGL.MarkerView = MarkerView;
+MapLibreGL.Annotation = Annotation;
+MapLibreGL.MarkerView = MarkerView;
 
 // sources
-MapboxGL.VectorSource = VectorSource;
-MapboxGL.ShapeSource = ShapeSource;
-MapboxGL.RasterSource = RasterSource;
-MapboxGL.ImageSource = ImageSource;
-MapboxGL.Images = Images;
+MapLibreGL.VectorSource = VectorSource;
+MapLibreGL.ShapeSource = ShapeSource;
+MapLibreGL.RasterSource = RasterSource;
+MapLibreGL.ImageSource = ImageSource;
+MapLibreGL.Images = Images;
 
 // layers
-MapboxGL.FillLayer = FillLayer;
-MapboxGL.FillExtrusionLayer = FillExtrusionLayer;
-MapboxGL.HeatmapLayer = HeatmapLayer;
-MapboxGL.LineLayer = LineLayer;
-MapboxGL.CircleLayer = CircleLayer;
-MapboxGL.SymbolLayer = SymbolLayer;
-MapboxGL.RasterLayer = RasterLayer;
-MapboxGL.BackgroundLayer = BackgroundLayer;
+MapLibreGL.FillLayer = FillLayer;
+MapLibreGL.FillExtrusionLayer = FillExtrusionLayer;
+MapLibreGL.HeatmapLayer = HeatmapLayer;
+MapLibreGL.LineLayer = LineLayer;
+MapLibreGL.CircleLayer = CircleLayer;
+MapLibreGL.SymbolLayer = SymbolLayer;
+MapLibreGL.RasterLayer = RasterLayer;
+MapLibreGL.BackgroundLayer = BackgroundLayer;
 
 // modules
-MapboxGL.locationManager = locationManager;
-MapboxGL.offlineManager = offlineManager;
-MapboxGL.snapshotManager = snapshotManager;
+MapLibreGL.locationManager = locationManager;
+MapLibreGL.offlineManager = offlineManager;
+MapLibreGL.snapshotManager = snapshotManager;
 
 // animated
-MapboxGL.Animated = Animated;
+MapLibreGL.Animated = Animated;
 
 // utils
-MapboxGL.AnimatedPoint = AnimatedMapPoint;
-MapboxGL.AnimatedCoordinatesArray = AnimatedCoordinatesArray;
-MapboxGL.AnimatedExtractCoordinateFromArray =
+MapLibreGL.AnimatedPoint = AnimatedMapPoint;
+MapLibreGL.AnimatedCoordinatesArray = AnimatedCoordinatesArray;
+MapLibreGL.AnimatedExtractCoordinateFromArray =
   AnimatedExtractCoordinateFromArray;
-MapboxGL.AnimatedRouteCoordinatesArray = AnimatedRouteCoordinatesArray;
-MapboxGL.AnimatedShape = AnimatedShape;
-MapboxGL.Logger = Logger;
+MapLibreGL.AnimatedRouteCoordinatesArray = AnimatedRouteCoordinatesArray;
+MapLibreGL.AnimatedShape = AnimatedShape;
+MapLibreGL.Logger = Logger;
 
-const {LineJoin} = MapboxGL;
+const {LineJoin} = MapLibreGL;
 
 export {
   MapView,
@@ -150,4 +146,4 @@ export {
   Style,
 };
 
-export default MapboxGL;
+export default MapLibreGL;

package/javascript/modules/location/locationManager.js

@@ -1,10 +1,10 @@
 import {NativeModules, NativeEventEmitter} from 'react-native';
 
-const MapboxGL = NativeModules.MGLModule;
-const MapboxGLLocationManager = NativeModules.MGLLocationModule;
+const MapLibreGL = NativeModules.MGLModule;
+const MapLibreGLLocationManager = NativeModules.MGLLocationModule;
 
 export const LocationModuleEventEmitter = new NativeEventEmitter(
-  MapboxGLLocationManager,
+  MapLibreGLLocationManager,
 );
 
 class LocationManager {
@@ -26,7 +26,7 @@ class LocationManager {
       // instead of throwing an exception
       try {
         lastKnownLocation =
-          await MapboxGLLocationManager.getLastKnownLocation();
+          await MapLibreGLLocationManager.getLastKnownLocation();
       } catch (error) {
         console.log('locationManager Error: ', error);
       }
@@ -66,10 +66,10 @@ class LocationManager {
 
   start(displacement = 0) {
     if (!this._isListening) {
-      MapboxGLLocationManager.start(displacement);
+      MapLibreGLLocationManager.start(displacement);
 
       this.subscription = LocationModuleEventEmitter.addListener(
-        MapboxGL.LocationCallbackName.Update,
+        MapLibreGL.LocationCallbackName.Update,
         this.onUpdate,
       );
 
@@ -78,7 +78,7 @@ class LocationManager {
   }
 
   stop() {
-    MapboxGLLocationManager.stop();
+    MapLibreGLLocationManager.stop();
 
     if (this._isListening) {
       this.subscription.remove();
@@ -88,7 +88,7 @@ class LocationManager {
   }
 
   setMinDisplacement(minDisplacement) {
-    MapboxGLLocationManager.setMinDisplacement(minDisplacement);
+    MapLibreGLLocationManager.setMinDisplacement(minDisplacement);
   }
 
   onUpdate(location) {

package/javascript/modules/offline/OfflinePack.js

@@ -1,6 +1,6 @@
 import {NativeModules} from 'react-native';
 
-const MapboxGLOfflineManager = NativeModules.MGLOfflineModule;
+const MapLibreGLOfflineManager = NativeModules.MGLOfflineModule;
 
 class OfflinePack {
   constructor(pack) {
@@ -25,15 +25,15 @@ class OfflinePack {
   }
 
   status() {
-    return MapboxGLOfflineManager.getPackStatus(this.name);
+    return MapLibreGLOfflineManager.getPackStatus(this.name);
   }
 
   resume() {
-    return MapboxGLOfflineManager.resumePackDownload(this.name);
+    return MapLibreGLOfflineManager.resumePackDownload(this.name);
   }
 
   pause() {
-    return MapboxGLOfflineManager.pausePackDownload(this.name);
+    return MapLibreGLOfflineManager.pausePackDownload(this.name);
   }
 }