Search packages, repositories and app categories

Package detailsv0.9.1

devicelocale

A Flutter package that can be used to extract the locales that are currently defined on a device with the current locale set as the first in the list.

AndroidiOSWebmacOSLinux
30-day downloads
126K
Likes
151
Pub points
150

Install package

flutter pub add devicelocale

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The devicelocale package is a Flutter utility that retrieves the list of locales configured on the user's device, with the current system locale appearing first. It supports multiple platforms including Android, iOS, Web, macOS, and Linux, making it ideal for applications requiring localization-aware behavior. By accessing native device settings, it enables apps to dynamically adapt to user preferences without manual configuration. The package is lightweight and integrates seamlessly into internationalization workflows.

Use cases

  • Dynamic language detection in multilingual apps
  • Auto-selecting user’s preferred language at launch
  • Supporting app localization based on device settings
  • Building region-aware features
  • Synchronizing UI language with system preferences

Key features

  • Returns device-defined locales with current locale first
  • Cross-platform support across major OSes
  • Simple API for retrieving locale lists
  • Integrates with Flutter's localization framework
  • Lightweight and dependency-free

Suitable for

  • Apps targeting global audiences
  • Localization-heavy applications
  • Developers using Flutter's intl package
  • Projects needing automatic locale fallback
  • Teams implementing responsive internationalization

Considerations

  • Relies on native device settings
  • Does not handle custom locale overrides
  • May return empty list if no locales are set
  • Requires platform-specific permissions on some systems
  • Limited to reading, not modifying device locale settings

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

devicelocale

Gets the device locale data, independent of the app locale settings.

Usage

import 'package:devicelocale/devicelocale.dart';

then

List languages = await Devicelocale.preferredLanguages;
String locale = await Devicelocale.currentLocale;

this should return a list of the preferred/current language locales setup on the device, with the current one being the first in the list or just the currently set device locale.

Android specific implementation (no-op on other platforms if supported)

Added per-app language preferences for Android (https://developer.android.com/about/versions/13/features/app-languages#kotlin) You can check if your current device is supported isLanguagePerAppSettingSupported And after checking if your device is supported you can set the per-app language preference with setLanguagePerApp(Locale) this will return true if success

Note for Linux

Since GNU/Linux and POSIX doesn't provide a standard API for getting the preferred languages, Devicelocale.preferredLanguages always returns the current locale.

Swift Package Manager (iOS / macOS)

Both CocoaPods and Swift Package Manager are supported; Flutter ≥ 3.44 uses SwiftPM automatically. To verify SwiftPM locally on Xcode 26+, clone the repository into a directory matching the pubspec name, otherwise the example app build fails with a SwiftPM identity-mismatch error (pub.dev users are unaffected):

git clone https://github.com/magnatronus/flutter-devicelocale.git devicelocale

Updates

Sept 2023

merged pull request for compatibility with AGP 8

Feb 2023

Added 2 new functions for this iOS issue

  • defaultLocale
  • defaultAsLocale
July 2022

Added support for per-app language preferences on Android (https://developer.android.com/about/versions/13/features/app-languages#kotlin) You can now set the per-app language if you have an in app language picker. Updated the demo app

May 2022

Merged pull requests

Oct 2021

Updated the code and APIs used by Flutter for an Android plugin - this was the source of the Deprecated API warning in the Android build.

July 2021

Add beta support for Linux

March 2021

Added test support for web

Updated for null safety

Jul 2020 Locale update v0.3.1

This is an update from a received request, where prior to 0.3.1 the 2 methods:

  • preferredLanguages
  • currentLocale

returned string values.

There are now 2 equivilent methods

  • preferredLanguagesAsLocales
  • currentAsLocale

that now also return a Locale object rather than a string.

releases
  • March 2021 1.0.0 Updated to null safety

  • July 2020 0.3.0 Updated Android to support Android Embedding V2

  • Apr 2020 0.2.3 Updated Android code from contributions from @ened

  • Mar 2020 0.2.2 Updated iOS so that if detected locale is null then it is not included in return value

  • Sep 2019 0.2.0 Updated Android following feedback from https://github.com/huzhirento . Fallback to the currentLocale when attempting to get a list of locales fro Android 7 and below as the getLocales() call is a feature of API 24 and failed for Android 7 and below.

Getting Started

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Categories

Dependencies

Dependency list 1 items

Source repository

Projects using this package