Documentation

Everything you need to integrate background location tracking into your React Native app. The native core stays the same. The wrapper and setup flow adapt to your stack.

Capacitor 8 React Native 0.76+

Quick Install

npm install @bglocation/react-nativenpx expo prebuild

Expo projects should use the config plugin plus a dev client. Bare React Native apps still need cd ios && pod install after installation.

Getting Started

Quick Start

Install, configure, and get your first location update in 5 minutes.

Guides

Background Tracking

Distance filter, heartbeat, accuracy, and battery impact.

HTTP Posting

Native HTTP delivery with automatic offline buffering and retry.

Geofencing

Circular regions, enter/exit/dwell transitions, and batch operations.

Permissions

iOS and Android permissions, background modes, and Expo config plugin.

Adaptive Filter

Speed-adaptive distance filter for optimal battery and accuracy.

Advanced

Debug Mode

Verbose logs, system sounds, and onDebug events for development.

Licensing

Trial mode, license key setup, perpetual model, and update gating.

Reference

Platform Differences

Feature availability and behavior differences across iOS, Android, and Web.

Error Codes

All error codes with descriptions, causes, and fixes.

Examples

Production-ready code for fleet tracking, fitness, delivery, and attendance.

Troubleshooting

Common problems and solutions for background location tracking.

Migration

Migrate from @capacitor-community/background-geolocation.

API Reference

Complete TypeScript API: methods, events, interfaces, and types.