system_theme 3.2.0

system_theme: ^3.2.0 copied to clipboard

Supported platforms #

Usage #

Import it:

import 'package:system_theme/system_theme.dart';

Get system accent color #

Use the getter SystemTheme.accentColor.accent to get the system accent color.

final accentColor = SystemTheme.accentColor.accent;

To reload the accent colors, use the method load():

await SystemTheme.accentColor.load();

You can load the colors before running the app, so the colors can't be wrong at runtime:

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.

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:

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:

SystemThemeBuilder(
  builder: (context, color) {
    return ColoredBox(
      color: color.accent, // Automatically updates when system theme changes
      child: const Center(
        child: Text('System Accent Color'),
      ),
    );
  },
);

Contribution #

Feel free to open an issue if you find an error or make pull requests.

Acknowlegments #

• @alexmercerind for the Windows implementation
• @pgiacomo69 for the accent color listener
• @HosamHasanRamadan for the iOS implementation