Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bdlukaa/system_theme
A Flutter plugin to get the color theme from the device
https://github.com/bdlukaa/system_theme
accent-colors flutter theme theme-info
Last synced: 6 days ago
JSON representation
A Flutter plugin to get the color theme from the device
- Host: GitHub
- URL: https://github.com/bdlukaa/system_theme
- Owner: bdlukaa
- Created: 2021-03-31T18:26:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T14:16:04.000Z (3 months ago)
- Last Synced: 2024-10-19T03:20:51.412Z (2 months ago)
- Topics: accent-colors, flutter, theme, theme-info
- Language: C++
- Homepage: https://pub.dev/packages/system_theme
- Size: 436 KB
- Stars: 35
- Watchers: 2
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: .github/README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
system_theme
A flutter plugin to get the current system theme information
- [Supported platforms](#supported-platforms)
- [Usage](#usage)
- [Get system accent color](#get-system-accent-color)
- [Contribution](#contribution)
- [Acknowlegments](#acknowlegments)
### Supported platforms
| Feature | Android 10+ | iOS | Web | MacOs 10.4+ | Windows 10+ and XBox | Linux GTK 3+ |
| ----------------- | :---------: | :-: | :-: | :---------: | :------------------: | :----------: |
| Get accent color | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Listen to changes | | | | | ✔️ | |
## Usage
Import it:
```dart
import 'package:system_theme/system_theme.dart';
```
### Get system accent color
Use the getter `SystemTheme.accentColor.accent` to get the system accent color.
```dart
final accentColor = SystemTheme.accentColor.accent;
```
To reload the accent colors, use the method `load()`:
```dart
await SystemTheme.accentColor.load();
```
You can load the colors before running the app, so the colors can't be wrong at runtime:
```dart
void main() async {
WidgetsFlutterBinding.ensureInitialized();
await SystemTheme.accentColor.load();
runApp(MyApp());
}
```
### Configure a fallback accent color
To avoid unexpected outcomes at runtime, it's recommended to configure your own fallback color. The fallback color is used if the system is not able to provide the color.
```dart
void main() async {
WidgetsFlutterBinding.ensureInitialized();
SystemTheme.fallbackColor = const Color(0xFF865432);
await SystemTheme.accentColor.load();
runApp(MyApp());
}
```
### Listen to changes on the system accent color
To simply listen to changes on the system accent color, use the `SystemTheme.onChange` stream:
```dart
SystemTheme.onChange.listen((event) {
debugPrint('Accent color changed to ${event.accentColor}');
});
```
Alteratively, you can the `SystemThemeBuilder` widget to listen to changes on the system accent color:
```dart
SystemThemeBuilder(builder: (context, accent) {
return ColoredBox(color: accent.accentColor);
});
```
### Checking if accent color is supported
The `flutter/foundation` package provides a `defaultTargetPlatform` getter, which can be used to check what platform the current app is running on.
You can check if the current platform supports accent colors using this extension method:
```dart
import 'package:flutter/foundation.dart' show defaultTargetPlatform;
void main() {
final supported = defaultTargetPlatform.supportsAccentColor;
print('Accent color is: ${supported ? 'supported' : 'not supported'} on the current platform');
}
```
## Contribution
Feel free to [open an issue](https://github.com/bdlukaa/system_theme/issues/new) if you find an error or [make pull requests](https://github.com/bdlukaa/system_theme/pulls).
### Acknowlegments
- [@alexmercerind](https://github.com/alexmercerind) for the Windows implementation
- [@pgiacomo69](https://github.com/pgiacomo69) for the accent color listener
- [@HosamHasanRamadan](https://github.com/HosamHasanRamadan) for the iOS implementation