@atomiqlab/react-native-mapbox-navigation 1.1.0 → 1.1.1

package/README.md

@@ -1,25 +1,33 @@
 # @atomiqlab/react-native-mapbox-navigation
 
-Native Mapbox turn-by-turn navigation bridge for Expo / React Native (iOS + Android).
+Native Mapbox turn-by-turn navigation for Expo apps on iOS and Android.
 
-## Highlights
+## Features
 
-- Full-screen native navigation (`startNavigation`).
-- Embedded native navigation (`MapboxNavigationView`).
-- Event stream: location, route progress, banner instruction, arrival, cancel, error.
-- Flexible camera/theme/style controls.
-- Expo config plugin for Android + iOS setup defaults.
+- Full-screen native navigation via `startNavigation`.
+- Embedded native navigation UI via `MapboxNavigationView`.
+- Real-time events: location, route progress, banner instruction, arrival, cancel, and error.
+- Runtime controls for mute, voice volume, distance unit, and language.
+- Navigation customization: camera mode/pitch/zoom, theme, map style, and UI visibility toggles.
+- Expo config plugin that applies required Android and iOS native setup.
+
+## Requirements
+
+- Expo SDK `>=50`
+- iOS `14+`
+- Mapbox access credentials:
+  - Public token (`pk...`)
+  - Downloads token (`sk...`) with `DOWNLOADS:READ`
 
 ## Installation
 
 ```bash
 npm install @atomiqlab/react-native-mapbox-navigation
-npx expo install expo-build-properties
 ```
 
-## Expo Config
+## Expo Setup
 
-Add plugin in app config:
+Add the plugin in your app config (`app.json` or `app.config.js`):
 
 ```json
 {
@@ -31,18 +39,18 @@ Add plugin in app config:
 }
 ```
 
-### Required tokens
+Set these environment variables:
 
-- `EXPO_PUBLIC_MAPBOX_ACCESS_TOKEN`: Mapbox public token (`pk...`)
-- `MAPBOX_DOWNLOADS_TOKEN`: Mapbox downloads token (`sk...`) with `DOWNLOADS:READ`
+- `EXPO_PUBLIC_MAPBOX_ACCESS_TOKEN` (Mapbox public token)
+- `MAPBOX_DOWNLOADS_TOKEN` (Mapbox downloads token)
 
-Then regenerate native projects:
+Regenerate native projects:
 
 ```bash
 npx expo prebuild --clean
 ```
 
-## Quick Usage
+## Quick Start
 
 ```ts
 import {
@@ -60,11 +68,14 @@ await startNavigation({
   destination: { latitude: 37.7847, longitude: -122.4073, name: "Downtown" },
   startOrigin: { latitude: 37.7749, longitude: -122.4194 },
   shouldSimulateRoute: true,
+  routeAlternatives: true,
   cameraMode: "following",
   uiTheme: "system",
+  distanceUnit: "metric",
+  language: "en",
 });
 
-const subs = [
+const subscriptions = [
   addLocationChangeListener((location) => console.log(location)),
   addRouteProgressChangeListener((progress) => console.log(progress)),
   addBannerInstructionListener((instruction) => console.log(instruction.primaryText)),
@@ -74,11 +85,11 @@ const subs = [
 ];
 
 // Cleanup
-subs.forEach((sub) => sub.remove());
+subscriptions.forEach((sub) => sub.remove());
 await stopNavigation();
 ```
 
-## Embedded View
+## Embedded Navigation View
 
 ```tsx
 import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation";
@@ -89,13 +100,16 @@ import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation"
   startOrigin={{ latitude: 37.7749, longitude: -122.4194 }}
   shouldSimulateRoute
   cameraMode="following"
+  showsTripProgress
   onBannerInstruction={(instruction) => console.log(instruction.primaryText)}
+  onRouteProgressChange={(progress) => console.log(progress.fractionTraveled)}
+  onError={(error) => console.warn(error.message)}
 />;
 ```
 
-## API Surface
+## API Overview
 
-### Core functions
+Core functions:
 
 - `startNavigation(options)`
 - `stopNavigation()`
@@ -106,7 +120,7 @@ import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation"
 - `setDistanceUnit(unit)`
 - `setLanguage(language)`
 
-### Listener helpers
+Event listeners:
 
 - `addLocationChangeListener(listener)`
 - `addRouteProgressChangeListener(listener)`
@@ -115,17 +129,17 @@ import { MapboxNavigationView } from "@atomiqlab/react-native-mapbox-navigation"
 - `addCancelNavigationListener(listener)`
 - `addErrorListener(listener)`
 
-### Key navigation options
+Main `NavigationOptions` fields:
 
-- Routing: `destination`, `startOrigin`, `waypoints`, `routeAlternatives`, `shouldSimulateRoute`
+- Route: `destination`, `startOrigin`, `waypoints`, `routeAlternatives`, `shouldSimulateRoute`
 - Camera: `cameraMode`, `cameraPitch`, `cameraZoom`
 - Theme/style: `uiTheme`, `mapStyleUri`, `mapStyleUriDay`, `mapStyleUriNight`
-- Guidance/UI: `distanceUnit`, `language`, `mute`, `voiceVolume`
-- Visibility toggles: `showsSpeedLimits`, `showsWayNameLabel`, `showsTripProgress`, `showsManeuverView`, `showsActionButtons`
+- Guidance: `distanceUnit`, `language`, `mute`, `voiceVolume`
+- UI toggles: `showsSpeedLimits`, `showsWayNameLabel`, `showsTripProgress`, `showsManeuverView`, `showsActionButtons`
 
-Full type reference: `src/MapboxNavigation.types.ts`
+Full types: `src/MapboxNavigation.types.ts`
 
-## Platform behavior
+## Platform Notes
 
-- Android: `startOrigin` optional; current location start is supported.
-- iOS: `startOrigin` optional; when omitted, the module resolves current device location (requires location permission).
+- Android: `startOrigin` is optional (current location is supported).
+- iOS: `startOrigin` is optional (current location is resolved at runtime with location permission).

package/app.plugin.js

@@ -150,5 +150,5 @@ const withMapboxNavigation = (config) => {
 module.exports = createRunOncePlugin(
   withMapboxNavigation,
   "react-native-mapbox-navigation-plugin",
-  "1.1.0"
+  "1.1.1"
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlab/react-native-mapbox-navigation",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Native Mapbox turn-by-turn navigation for Expo and React Native (iOS + Android)",
   "main": "src/index.tsx",
   "types": "src/index.tsx",