Geolocation

GitHubnpmcrates.io

API Reference:

Get and track the device’s current position, including information about altitude, heading, and speed (if available).

Supported Platforms

This plugin requires a Rust version of at least 1.77.2

[TABLE]

Setup

Install the geolocation plugin to get started.

• Automatic
• Manual

Use your project’s package manager to add the dependency:

• npm
• yarn
• pnpm
• deno
• bun
• cargo

npm run tauri add geolocation

yarn run tauri add geolocation

pnpm tauri add geolocation

deno task tauri add geolocation

bun tauri add geolocation

cargo tauri add geolocation

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

   cargo add tauri-plugin-geolocation --target 'cfg(any(target_os = "android", target_os = "ios"))'

2. Modify lib.rs to initialize the plugin:

   #[cfg_attr(mobile, tauri::mobile_entry_point)]pub fn run() {    tauri::Builder::default()        .setup(|app| {            #[cfg(mobile)]            app.handle().plugin(tauri_plugin_geolocation::init());            Ok(())        })        .run(tauri::generate_context!())        .expect("error while running tauri application");}

   src-tauri/src/lib.rs

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   • npm
   • yarn
   • pnpm
   • deno
   • bun

   npm install @tauri-apps/plugin-geolocation

   yarn add @tauri-apps/plugin-geolocation

   pnpm add @tauri-apps/plugin-geolocation

   deno add npm:@tauri-apps/plugin-geolocation

   bun add @tauri-apps/plugin-geolocation

Configuration

iOS

Apple requires privacy descriptions to be specified in Info.plist for location information, where you should describe why your app needs to access it. Illustrated below is an example description:

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"><plist version="1.0">    <dict>        <key>NSLocationWhenInUseUsageDescription</key>        <string>Required to do XY</string>    </dict></plist>

Android

This plugin automatically adds the following permissions to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /><uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

If your app requires GPS functionality to function, you should add the following to your AndroidManifest.xml file:

<uses-feature android:name="android.hardware.location.gps" android:required="true" />

The Google Play Store uses this property to decide whether it should show the app to devices without GPS capabilities.

Usage

The geolocation plugin is available in JavaScript.

import {  checkPermissions,  requestPermissions,  getCurrentPosition,  watchPosition,} from '@tauri-apps/plugin-geolocation';
let permissions = await checkPermissions();if (  permissions.location === 'prompt' ||  permissions.location === 'prompt-with-rationale') {  permissions = await requestPermissions(['location']);}
if (permissions.location === 'granted') {  const pos = await getCurrentPosition();
  await watchPosition(    { enableHighAccuracy: true, timeout: 10000, maximumAge: 0 },    (pos) => {      console.log(pos);    }  );}

Permissions

By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

{  "$schema": "../gen/schemas/mobile-schema.json",  "identifier": "mobile-capability",  "windows": ["main"],  "platforms": ["iOS", "android"],  "permissions": [    "core:default",    "geolocation:allow-check-permissions",    "geolocation:allow-request-permissions",    "geolocation:allow-get-current-position",    "geolocation:allow-watch-position"  ]}

src-tauri/capabilities/mobile.json

Permission Table

Support on Open CollectiveSponsor on GitHub

© 2026 Tauri Contributors. CC-BY / MIT

Last updated Oct 08, 2026