@ingissa/navcore-mapbox
v1.0.12
Published
Mapbox GL adapter for NavCore — renderer and directions provider.
Readme
@ingissa/navcore-mapbox
Mapbox Directions provider adapter for the NavCore navigation engine.
Overview
@ingissa/navcore-mapbox provides MapboxDirectionsProvider, an implementation of NavCore's DirectionsProvider interface targeting the Mapbox Directions API.
Key Capabilities
- Direct NavCore integration: Directly compatible with
createNavigationSessionandcreateRoutePlan. - Automatic waypoint chunking: Transparently splits routes with more than 25 waypoints into chunks, querying each chunk and stitching geometry with the
OVERLAP_1strategy. - Configurable routing profiles: Supports
driving,driving-traffic,cycling, andwalking.
[!NOTE]
@ingissa/navcore-mapboxis a routing directions provider only. It does not export a map renderer. For map rendering in React Native, use@rnmapbox/mapsorreact-native-mapsdirectly in your application components by consuming state fromuseNavSelector().
Installation
npm install @ingissa/navcore-mapbox @ingissa/navcore-corePeer Dependencies
@ingissa/navcore-core:^1.0.9(required)@rnmapbox/maps:>=10.0.0(optional, for React Native applications)
Quickstart
import { createNavigationSession } from '@ingissa/navcore-core';
import { MapboxDirectionsProvider } from '@ingissa/navcore-mapbox';
// Initialize Mapbox provider with your access token
const provider = new MapboxDirectionsProvider({
accessToken: 'pk.eyJ1...',
profile: 'driving-traffic', // 'driving' | 'driving-traffic' | 'cycling' | 'walking'
maxWaypointsPerChunk: 25, // Default: 25 (Mapbox API limit)
});
// Pass to a NavigationSession
const nav = createNavigationSession({
provider,
providerName: 'mapbox',
engineOptions: { isDev: true },
});
// Fetch route and start navigation
const plan = await nav.navigate({
origin: [2.3522, 48.8566],
destination: [2.3009, 48.8741],
});
console.log(`Route loaded: ${plan.distanceM}m, duration: ${plan.durationS}s`);Standalone Usage
import { MapboxDirectionsProvider } from '@ingissa/navcore-mapbox';
const provider = new MapboxDirectionsProvider({
accessToken: process.env.MAPBOX_TOKEN!,
});
const result = await provider.getRoute([
[2.3522, 48.8566],
[2.3300, 48.8650],
[2.3009, 48.8741],
]);
console.log('Coordinates:', result.geometry.length);
console.log('Distance in metres:', result.distance);
console.log('Duration in seconds:', result.duration);Documentation
Licensing
Proprietary software. Copyright (c) 2026 Abdelnasser Aitabi. All rights reserved. No license is granted except by separate written agreement.
