refactor!:NativeUserLocation is deprecated use LocationPuck

rnmapbox · Dec 1, 2023 · f2aa82d · f2aa82d
1 parent c0b52cc
commit f2aa82d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/__tests__/interface.test.js b/__tests__/interface.test.js
@@ -14,7 +14,8 @@ describe('Public Interface', () => {
       'Callout',
       'Camera',
       'UserLocation',
-      'NativeUserLocation',
+      'NativeUserLocation', // deprecated
+      'LocationPuck',
       'StyleImport',
       'Viewport',
       'CustomLocationProvider',

diff --git a/src/Mapbox.ts b/src/Mapbox.ts
@@ -19,7 +19,7 @@ export {
   default as UserLocation,
   UserLocationRenderMode,
 } from './components/UserLocation';
-export { default as NativeUserLocation } from './components/NativeUserLocation';
+export { default as LocationPuck } from './components/LocationPuck';
 export { default as VectorSource } from './components/VectorSource';
 export { ShapeSource } from './components/ShapeSource';
 export { default as RasterSource } from './components/RasterSource';
@@ -87,6 +87,7 @@ import { deprecatedClass } from './utils/deprecation';
 import { AnimatedPoint } from './classes';
 import { UserTrackingMode } from './components/Camera';
 import MovePointShapeAnimator from './shape_animators/MovePointShapeAnimator';
+import LocationPuck from './components/LocationPuck';
 
 /** @deprecated This will be removed in a future release. Use `AnimatedPoint` instead. */
 
@@ -95,6 +96,9 @@ export const AnimatedMapPoint = deprecatedClass(
   'AnimatedMapPoint is deprecated please use AnimatedPoint',
 );
 
+/** @deprecacated NativeUserLocation will be removed in future release. Use `LocationPuck` instead. */
+export const NativeUserLocation = LocationPuck;
+
 // types:
 export enum StyleURL {
   Street = 'mapbox://styles/mapbox/streets-v11',

diff --git a/src/components/NativeUserLocation.tsx → src/components/LocationPuck.tsx b/src/components/NativeUserLocation.tsx → src/components/LocationPuck.tsx
@@ -101,13 +101,16 @@ const defaultProps = {
   visible: true,
 } as const;
 
-const NativeUserLocation = memo((props: Props) => {
+/**
+ * Renders a puck on the map that shows the device's current location.
+ */
+const LocationPuck = memo((props: Props) => {
   const { iosShowsUserHeadingIndicator, pulsing, ...rest } = props;
   const nativePulsing = pulsing ? _pulsingToNative(pulsing) : undefined;
   let baseProps: NativeProps = { ...defaultProps, pulsing: nativePulsing };
   if (iosShowsUserHeadingIndicator) {
     console.warn(
-      'NativeUserLocation: iosShowsUserHeadingIndicator is deprecated, use puckBearingEnabled={true} puckBearing="heading" instead',
+      'LocationPuck: iosShowsUserHeadingIndicator is deprecated, use puckBearingEnabled={true} puckBearing="heading" instead',
     );
 
     baseProps = {
@@ -137,4 +140,4 @@ function _pulsingToNative(
   };
 }
 
-export default NativeUserLocation;
+export default LocationPuck;
diff --git a/src/components/UserLocation.tsx b/src/components/UserLocation.tsx
@@ -7,7 +7,7 @@ import { CircleLayerStyle } from '../Mapbox';
 import Annotation from './Annotation';
 import CircleLayer from './CircleLayer';
 import HeadingIndicator from './HeadingIndicator';
-import NativeUserLocation from './NativeUserLocation';
+import NativeUserLocation from './LocationPuck';
 
 const mapboxBlue = 'rgba(51, 181, 229, 100)';