system_theme 2.3.1 copy "system_theme: ^2.3.1" to clipboard
system_theme: ^2.3.1 copied to clipboard

A plugin to get the current system theme info. Supports Android, Web, Windows, Linux and macOS


A flutter plugin to get the current system theme information

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:

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 {
  await SystemTheme.accentColor.load();

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 {

  SystemTheme.fallbackColor = const Color(0xFF865432);
  await SystemTheme.accentColor.load();


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, 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:

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 if you find an error or make pull requests.

Acknowlegments #

pub points



A plugin to get the current system theme info. Supports Android, Web, Windows, Linux and macOS

Repository (GitHub)
View/report issues


API reference


BSD-3-Clause (LICENSE)


flutter, system_theme_web


Packages that depend on system_theme