Code Monkey home page Code Monkey logo

system_theme's Introduction

system_theme

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.