Search packages, repositories and app categories

Package detailsv3.3.0

system_theme

A Flutter Plugin to retrieve and listen to the system's accent color. Supports Android, iOS, Web, Windows, macOS, and Linux.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
8.3K
Likes
123
Pub points
160

Install package

flutter pub add system_theme

Package Overview

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

The system_theme package enables Flutter applications to access and respond to the system's accent color across multiple platforms, including Android, iOS, Web, macOS, Windows, and Linux. It provides a simple way to retrieve the current system accent color and listen for changes, enhancing app UI consistency with device-level themes. Ideal for apps aiming to match native system aesthetics without manual theme management.

Use cases

  • Matching system accent colors in app UI
  • Creating dynamic themes based on system preferences
  • Building cross-platform apps with native look and feel
  • Automatically updating colors when system theme changes
  • Enhancing accessibility with system-defined color schemes

Key features

  • Real-time listening to system accent color changes
  • Cross-platform support for all major operating systems
  • Simple API for retrieving current accent color
  • Automatic updates when system theme changes
  • Lightweight and easy to integrate

Suitable for

  • Developers targeting native-like UIs
  • Apps requiring dynamic theme adaptation
  • Projects focused on accessibility and user experience
  • Cross-platform Flutter applications
  • Designers wanting seamless system integration

Considerations

  • Limited to accent color; does not manage full theme modes
  • Behavior may vary slightly between platforms
  • Requires platform-specific permissions on some OSes
  • Not suitable for complex theme management beyond accent colors
  • Depends on system-level color availability

Original README

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

system_theme

A flutter plugin to retrieve the current system theme information

Supported platforms
Platform Accent Color Listen to Color Changes Minimum Version
Android ✔️ Android 10+
iOS ✔️ iOS 14+
Windows ✔️ ✔️ Windows 10+
macOS ✔️ ✔️ Mojave 10.14+
Linux ✔️ GTK 3+
Web ✔️ All modern browsers

Usage

Import it:

import 'package:system_theme/system_theme.dart';
Get system accent color

Use the getter SystemTheme.accentColor.accent to get the 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'),
      ),
    );
  },
);
Notes

On iOS 14 and later, this is the application's SwiftUI accent color (for example, the accent configured in the app's asset catalog), or the platform's app-level default when none is configured. Unlike Windows and macOS, iOS does not expose an equivalent global user-selected system accent color. If the app accent is unavailable or cannot be converted, the existing fallback or last loaded palette is retained. iOS does not automatically report accent changes; call load() to refresh it.

Contribution

See native testing for platform test commands and manual verification steps.

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

Acknowlegments

Categories

Dependencies

Dependency list 1 items

  • system_theme_web^0.0.5

Source repository

Projects using this package