A Flutter plugin to get device region settings such as measurement system and temperature units.
| Android | iOS | MacOS | Web | Linux | Windows |
|---|---|---|---|---|---|
| ✅ | ✅ |
To use this plugin, add region_settings as a dependency in your pubspec.yaml file.
Call RegionSettings to access device region settings including temperature unit and measurement system preferences:
import 'package:region_settings/region_settings.dart';
final RegionSettings regionSettings = await RegionSettings.getSettings();
TemperatureUnit temperatureUnits = regionSettings.temperatureUnits;
bool usesMetricSystem = regionSettings.usesMetricSystem;temperatureUnits is set to an enum with the following possible values:
| enum | value |
|---|---|
| TemperatureUnit.celsius | 'C' |
| TemperatureUnit.fahrenheit | 'F' |
This plugin accesses Language & Region settings on iOS. Users can specify a Temperature preference (degrees C or degrees F) and a Measurement System preference (US, UK, or Metric). For the purposes of this plugin, the UK Measurement System is considered equivalent to Metric.
Note that the Temperature preference is not honored when running on iOS simulators; however, it is reported correctly on physical devices.
Android does not have an OS-level measurement system setting. Instead, the plugin must guess the measurement system based on the device's locale. The plugin considers the following countries to be non-Metric:
- American Samoa (US)
- Bahamas
- Belize
- Cayman Islands
- Guam (US)
- Liberia
- Marshall Islands
- Micronesia
- Northern Mariana Islands (US)
- Palau
- Turks and Caicos Islands
- United States
- US Minor Outlying Islands
- US Virgin Islands
All other countries are considered to be Metric users.
If the above list of countries is found to be inaccurate, please submit an issue or PR.
Android 14+ includes a separate Temperature preference in Regional Preferences. If available, the plugin will use this setting. If not available, the plugin will fall back to the locale, where Metric countries are assumed to use Celsius and non-Metric countries are assumed to use Fahrenheit.
This plugin was written primarily to improve support for region defaults in Cuppa.
Author: Nathan Cosgray