https://github.com/birjuvachhani/adaptive_theme
Easiest way to add support for light and dark theme in your flutter app.
https://github.com/birjuvachhani/adaptive_theme
adaptive flutter flutter-package flutter-ui flutter-widget hacktoberfest hacktoberfest2023 hactoberfest hactoberfest-accepted theme
Last synced: about 1 month ago
JSON representation
Easiest way to add support for light and dark theme in your flutter app.
- Host: GitHub
- URL: https://github.com/birjuvachhani/adaptive_theme
- Owner: BirjuVachhani
- License: apache-2.0
- Created: 2020-05-03T08:28:57.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T04:50:02.000Z (3 months ago)
- Last Synced: 2025-04-14T01:51:24.678Z (2 months ago)
- Topics: adaptive, flutter, flutter-package, flutter-ui, flutter-widget, hacktoberfest, hacktoberfest2023, hactoberfest, hactoberfest-accepted, theme
- Language: Dart
- Homepage: https://pub.dev/packages/adaptive_theme
- Size: 684 KB
- Stars: 560
- Watchers: 7
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Adaptive Theme
The easiest way to add support for **light** and **dark** themes in your Flutter app. It allows you
to manually set a light or dark theme and also lets you define themes based on the system. It also
persists the theme mode changes across app restarts.
[](https://github.com/BirjuVachhani/adaptive_theme/actions) [](https://github.com/BirjuVachhani/adaptive_theme/actions) [](https://codecov.io/gh/birjuvachhani/adaptive_theme) [](https://pub.dev/packages/adaptive_theme)
Demo: [Adaptive Theme](https://adaptivetheme.codemagic.app/)
## Index
- [Getting Started](#getting-started)
- [Initialization](#initialization)
- [Changing Theme Mode](#changing-theme-mode)
- [Toggle Theme Mode](#toggle-theme-mode)
- [Changing Themes](#changing-themes)
- [Reset Theme](#reset-theme)
- [Set Default Theme](#set-default-theme)
- [Handling App Start](#get-themeMode-at-app-start)
- [Handling Theme Changes](#listen-to-the-theme-mode-changes)
- [Using a floating theme button overlay](#using-a-floating-theme-button-overlay)
- [Caveats](#caveats)
- [Non-Persistent theme changes](#non-persistent-theme-changes)
- [Using SharedPreferences](#using-sharedpreferences)
- [Using CupertinoTheme](#Using-CupertinoTheme)
- [Changing Cupertino Theme](#changing-cupertino-theme)
- [Contribution](#contribution)
- [License](#license)
## Getting Started
Add the following dependency to your `pubspec.yaml`
```yaml
dependencies:
adaptive_theme:
```
## Initialization
You need to wrap your `MaterialApp` with `AdaptiveTheme` in order to apply themes.
```dart
import 'package:adaptive_theme/adaptive_theme.dart';
import 'package:flutter/material.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return AdaptiveTheme(
light: ThemeData.light(useMaterial3: true),
dark: ThemeData.dark(useMaterial3: true),
initial: AdaptiveThemeMode.light,
builder: (theme, darkTheme) => MaterialApp(
title: 'Adaptive Theme Demo',
theme: theme,
darkTheme: darkTheme,
home: MyHomePage(),
),
);
}
}
```
## Changing Theme Mode
Now that you have initialized your app as mentioned above. It's very easy and straightforward to
change your theme modes: light to dark, dark to light, or to system default.
```dart
// sets theme mode to dark
AdaptiveTheme.of(context).setDark();
// sets theme mode to light
AdaptiveTheme.of(context).setLight();
// sets theme mode to system default
AdaptiveTheme.of(context).setSystem();
```
## Toggle Theme Mode
AdaptiveTheme allows you to toggle between light, dark, and system themes the easiest way possible.
```dart
AdaptiveTheme.of(context).toggleThemeMode();
```
## Changing Themes
If you want to change the theme entirely, e.g., change all the colors to some other color swatch,
then you can use `setTheme` method.
```dart
AdaptiveTheme.of(context).setTheme(
light: ThemeData(
useMaterial3: true,
brightness: Brightness.light,
colorSchemeSeed: Colors.purple,
),
dark: ThemeData(
useMaterial3: true,
brightness: Brightness.dark,
colorSchemeSeed: Colors.purple,
),
);
```
## Reset Theme
`AdaptiveTheme` is smart enough to keep your **default** themes handy that you provided at the time
of initialization. You can fall back to those default themes in a very easy way.
```dart
AdaptiveTheme.of(context).reset();
```
This will reset your theme as well as theme mode to the initial values provided at the time of
initialization.
## Set Default Theme
`AdaptiveTheme` persists theme mode changes across app restarts and uses the default themes to set
theme modes (light/dark) on. You can change this behavior if you want to set a different theme as
the default theme other than the one provided at the time of initialization.
This comes in handy when you're fetching themes remotely on app starts and the setting theme as the
current theme.
Doing so is quite easy. You would set a new theme normally as you do by calling `setTheme` method
but this time, with a flag isDefault set to true.
> This is only useful when you might want to reset to default theme at some point.
```dart
AdaptiveTheme.of(context).setTheme(
light: ThemeData(
useMaterial3: true,
brightness: Brightness.light,
colorSchemeSeed: Colors.blue,
),
dark: ThemeData(
useMaterial3: true,
brightness: Brightness.dark,
colorSchemeSeed: Colors.blue,
),
isDefault: true,
);
```
## Get ThemeMode at App Start
When you change your theme, the next app run won't be able to pick the most recent theme directly
before rendering with the default theme for the first time. This is because at the time of
initialization, we cannot run async code to get the previous theme mode. However, it can be avoided
if you make your main() method async and load the previous theme mode asynchronously. The example
below shows how it can be done.
```dart
void main() async {
WidgetsFlutterBinding.ensureInitialized();
final savedThemeMode = await AdaptiveTheme.getThemeMode();
runApp(MyApp(savedThemeMode: savedThemeMode));
}
```
```dart
AdaptiveTheme(
light: lightTheme,
dark: darkTheme,
initial: savedThemeMode ?? AdaptiveThemeMode.light,
builder: (theme, darkTheme) => MaterialApp(
title: 'Adaptive Theme Demo',
theme: theme,
darkTheme: darkTheme,
home: MyHomePage(),
),
)
```
Notice that I passed the retrieved theme mode to my material app so that I can use it while
initializing the default theme. This helps to avoid theme change flickering on app startup.
## Listen to the theme mode changes
You can listen to the changes in the theme mode via a ValueNotifier. This can be useful when
designing a theme settings screen or developing UI to show theme status.
```dart
AdaptiveTheme.of(context).modeChangeNotifier.addListener(() {
// do your thing.
});
```
Or you can utilize it to react on UI with
```dart
ValueListenableBuilder(
valueListenable: AdaptiveTheme.of(context).modeChangeNotifier,
builder: (_, mode, child) {
// update your UI
return Container();
},
);
```
## Using a floating theme button overlay
Starting from `v3.3.0`, you can now set `debugShowFloatingThemeButton` to `true` and enable a
floating button that can be used to toggle theme mode very easily. This is useful when you want to
test your app with both light and dark themes without restarting the app or navigating to the
settings screen where your theme settings are available.
```dart
AdaptiveTheme(
light: ThemeData.light(),
dark: ThemeData.dark(),
debugShowFloatingThemeButton: true, // <------ add this line
initial: AdaptiveThemeMode.light,
builder: (theme, darkTheme) => MaterialApp(
theme: theme,
darkTheme: darkTheme,
home: MyHomePage(),
),
);
```
[Video](https://github.com/BirjuVachhani/adaptive_theme/assets/20423471/c3a9fd05-c266-468c-a929-f54c17ece3ba)
## Caveats
#### Non-Persistent theme changes
> This is only useful in scenarios where you load your themes dynamically from network in the splash screen or some initial screens of the app. Please note that AdaptiveTheme does not persist the themes, it only persists the theme modes(light/dark/system). Any changes made to the provided themes won't be persisted and you will have to do the same changes at the time of the initialization if you want them to apply every time app is opened. e.g changing the accent color.
#### Using SharedPreferences
> This package uses [shared_preferences](https://pub.dev/packages/shared_preferences) plugin internally to persist theme mode changes. If your app uses [shared_preferences](https://pub.dev/packages/shared_preferences) which might be the case all the time, clearing your [shared_preferences](https://pub.dev/packages/shared_preferences) at the time of logging out or signing out might clear these preferences too. Be careful not to clear these preferences if you want it to be persisted.
```dart
/// Do not remove this key from preferences
AdaptiveTheme.prefKey
```
You can use the above key to exclude it while clearing all the preferences.
Or you can call AdaptiveTheme.persist() method after clearing the preferences to make it persistable
again as shown below.
```dart
final prefs = await SharedPreferences.getInstance();
await prefs.clear();
AdaptiveTheme.persist();
```
## Using CupertinoTheme
Wrap your `CupertinoApp` with `CupertinoAdaptiveTheme` in order to apply themes.
```dart
import 'package:adaptive_theme/adaptive_theme.dart';
import 'package:flutter/material.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return CupertinoAdaptiveTheme(
light: CupertinoThemeData(
brightness: Brightness.light,
),
dark: CupertinoThemeData(
brightness: Brightness.dark,
),
initial: AdaptiveThemeMode.light,
builder: (theme) => CupertinoApp(
title: 'Adaptive Theme Demo',
theme: theme,
darkTheme: darkTheme,
home: MyHomePage(),
),
);
}
}
```
#### Changing Cupertino Theme
```dart
// sets dark theme
CupertinoAdaptiveTheme.of(context).setDark();
// sets light theme
CupertinoAdaptiveTheme.of(context).setLight();
// sets system default theme
CupertinoAdaptiveTheme.of(context).setSystem();
```
## Contribution
You are most welcome to contribute to this project!
Please have a look at [Contributing Guidelines](https://github.com/BirjuVachhani/adaptive_theme/blob/main/CONTRIBUTING.md), before contributing and proposing a change.
#### Liked Adaptive Theme?
Show some love and support by starring the repository.
Or You can
## License
```
Copyright © 2020 Birju Vachhani
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```