Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lvfarias/easy_theme
A package to generate MaterialColors and a ThemeData for your Flutter App in an EASY and FAST WAY.
https://github.com/lvfarias/easy_theme
dart flutter generator material material-colors material-theme theme theme-customizer
Last synced: 29 days ago
JSON representation
A package to generate MaterialColors and a ThemeData for your Flutter App in an EASY and FAST WAY.
- Host: GitHub
- URL: https://github.com/lvfarias/easy_theme
- Owner: LvFarias
- License: other
- Created: 2020-09-28T22:25:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-19T14:31:17.000Z (about 4 years ago)
- Last Synced: 2024-12-01T14:40:33.717Z (about 1 month ago)
- Topics: dart, flutter, generator, material, material-colors, material-theme, theme, theme-customizer
- Language: Dart
- Homepage: https://pub.dev/packages/easy_theme
- Size: 77.1 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Easy Theme
      
## Sumary
- [Description](#description)
- [Installation](#installation)
- [Depend on it](#depend-on-it)
- [Install it](#install-it)
- [Import it](#import-it)
- [What is CustomTheme](#what-is-customtheme)
- [EasyColors](#easycolors)
- [Customize](#customize)
- [Exemple](#exemple)
- [Authors](#authors)
## Description
A package to generate MaterialColors and a ThemeData for your Flutter App in an __EASY__ and __FAST WAY__.
## Installation
### Depend on it
Add this to your package's pubspec.yaml file:
```yaml
dependencies:
easy_theme: ^1.0.2
```
### Install it
You can install packages from the command line:
with Flutter:
```bash
flutter pub get
```
Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.
### Import it
Now in your Dart code, you can use:
```dart
import 'package:easy_theme/easy_theme.dart';
```
### Use it
Now in your Dart code, you can use:
```dart
final EasyTheme myCustomTheme = EasyTheme(primary: Colors.blue);
```
## What is CustomTheme?
Is the main class of the package, it will be responsible for generating a theme for your app and a color variable, which facilitates work and understanding.
When instantiation the class, it is mandatory to pass a primary color as a parameter, but it is also possible to pass the colors: secondary, success, info, warning, error.
It is also possible to pass a brightness to build dark or light themes.
This class there are two public functions, they are:
- __getColors__ that returns an object of type [EasyColors](#EasyColors)
- __getTheme__ that returns an object of type [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html)
### EasyColors
Is a class that transforms the colors passed in CustomTheme to MaterialColors, and puts it in an easy to understand structure to be used in the application.
It contains the following MaterialColors:
primary; secondary; success; info; warning; error; white; black;
White is #FFFFFF and Black is #000000.
Secondary, if not provided at CustomTheme instantiation, a complementary color to the primary calculated by the EasyColors class.
## Customize
Try to pass more colors to CustomTheme for a more personalized theme.
```dart
final EasyTheme myEasyTheme = EasyTheme(
primary: Color(0XFF0F4C81),
secondary: Color(0XFFCFA904),
success: : Color(0XFF268209),
info: : Color(0XFF09827A),
warning: : Color(0XFFB49404),
error: : Color(0XFF82211D),
brightness: Brightness.light,
);
```
You can also create more than one theme for your application, as in the example below a dark and light theme is created
```dart
final EasyTheme myEasyThemeLight = EasyTheme(
primary: Color(0XFF0F4C81),
secondary: Color(0XFFCFA904),
success: : Color(0XFF268209),
info: : Color(0XFF09827A),
warning: : Color(0XFFB49404),
error: : Color(0XFF82211D),
brightness: Brightness.light,
);
final EasyTheme myEasyThemeDark = EasyTheme(
primary: Color(0XFFCFA904),
secondary: Color(0XFF007FB1),
success: : Color(0XFF5AB009),
info: : Color(0XFF1283B0),
warning: : Color(0XFFFCC319),
error: : Color(0XFFB03009),
brightness: Brightness.dark,
);
```
## Authors
- [Luan Vasco de Farias](https://github.com/LvFarias)
## Exemple
```dart
////////// IMPORT EASY THEME //////////
import 'package:easy_theme/easy_theme.dart';
/// Creating a Easy Theme based on the blue color (`Colors.blue`)
final EasyTheme myCustomTheme = EasyTheme(primary: Colors.blue);
/// get the ThemeData object created by the EasyTheme
final ThemeData myTheme = myCustomTheme.getTheme();
/// get the EasyColors object created by the EasyTheme
final EasyColors myColors = myCustomTheme.getColors();
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Theme Test',
/// use `myTheme` in your
theme: myTheme,
home: MyHomePage(),
);
}
}
```