import TabItem from '@theme/TabItem'; import Tabs from '@theme/Tabs'; import {ClassAll, CodeExample} from '@site/src/components/crocodocs';

Geolocator

Access device location services in your Flet app using the flet-geolocator extension. The control wraps Flutter's geolocator package and exposes async helpers for permission checks and position streams.

Platform Support

Platform	Windows	macOS	Linux	iOS	Android	Web
Supported	✅	✅	✅	✅	✅	✅

Usage

Add flet-geolocator to your project dependencies:

<Tabs groupId="uv--pip"> <TabItem value="uv" label="uv"> ```bash uv add flet-geolocator ``` </TabItem> <TabItem value="pip" label="pip"> ```bash pip install flet-geolocator # (1)! ```

1. After this, you will have to manually add this package to your requirements.txt or pyproject.toml. </TabItem>

</Tabs> ## Requirements

The below sections show the required configurations for each platform.

Android

Configuration to be made to access the device's location:

• ACCESS_FINE_LOCATION: Allows access precise location. Will be preferred over ACCESS_COARSE_LOCATION, if both are set.
• ACCESS_COARSE_LOCATION: Allows access approximate location.
• ACCESS_BACKGROUND_LOCATION (optional): Allows access to location even when the app is in the background. Effective as from Android 10 (API level 29).
• FOREGROUND_SERVICE_LOCATION (optional): Allows access to location even when the app is in the foreground. Effective as from Android 14 (API level 34).

:::note[Note]

• At least one of ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION permission is required to get location updates, with the former being preferred if both are set.
• Specifying the ACCESS_COARSE_LOCATION permission results in location updates with accuracy approximately equivalent to a city block. It might take a long time (minutes) before you will get your first locations fix as ACCESS_COARSE_LOCATION will only use the network services to calculate the position of the device. More information here. :::

<Tabs groupId="flet-build--pyproject-toml"> <TabItem value="flet-build" label="flet build"> ```bash flet build apk \ --android-permissions android.permission.ACCESS_FINE_LOCATION=true \ --android-permissions android.permission.ACCESS_COARSE_LOCATION=true \ --android-permissions android.permission.ACCESS_BACKGROUND_LOCATION=true \ --android-permissions android.permission.FOREGROUND_SERVICE_LOCATION=true ``` </TabItem> <TabItem value="pyproject-toml" label="pyproject.toml"> ```toml [tool.flet.android.permission] "android.permission.ACCESS_FINE_LOCATION" = true "android.permission.ACCESS_COARSE_LOCATION" = true "android.permission.ACCESS_BACKGROUND_LOCATION" = true "android.permission.FOREGROUND_SERVICE_LOCATION" = true ``` </TabItem> </Tabs> See also:

• setting Android permissions

iOS

Configuration to be made to access the device's location:

<Tabs groupId="flet-build--pyproject-toml"> <TabItem value="flet-build" label="flet build"> ```bash flet build ipa \ --info-plist NSLocationWhenInUseUsageDescription="Some message to describe why you need this permission..." ``` </TabItem> <TabItem value="pyproject-toml" label="pyproject.toml"> ```toml [tool.flet.ios.info] NSLocationWhenInUseUsageDescription = "Some message to describe why you need this permission..." ``` </TabItem> </Tabs> See also:

• setting iOS Info.plist entries

macOS

Configuration to be made to access the device's location:

<Tabs groupId="flet-build--pyproject-toml"> <TabItem value="flet-build" label="flet build"> ```bash flet build macos \ --info-plist NSLocationUsageDescription="Some message to describe why you need this permission..." \ --macos-entitlements com.apple.security.personal-information.location=true ``` </TabItem> <TabItem value="pyproject-toml" label="pyproject.toml"> ```toml [tool.flet.macos.info] NSLocationUsageDescription = "Some message to describe why you need this permission..."

[tool.flet.macos.entitlement] "com.apple.security.personal-information.location" = true

</TabItem> <TabItem value="pyproject-toml" label="pyproject.toml"> ```toml [tool.flet] permissions = ["location"] ``` </TabItem> </Tabs> ## Example

<CodeExample path={frontMatter.examples + '/example_1/main.py'} language="python" />

Description

<ClassAll name={frontMatter.class_name} />