# flutter_flavor 3.1.4 We can create different flavors, and thus have different instances of our apps before publishing it on the App Store and Google Play. ## Installing ``` export PUB_HOSTED_URL=https://pub.mirror.p-hatan.ir flutter pub add flutter_flavor ``` Published: 2024-12-06T22:43:41.546267Z Expected archive SHA-256: 611e2279cb250c2cb2565757e28545527f963692614a4b0671fa2e1e985c8c71 Available in cache; verification: upstream_checksum ## Direct dependencies - flutter: map[sdk:flutter] ## Package README (untrusted upstream documentation) # flutter_flavor [![pub package](https://img.shields.io/pub/v/flutter_flavor.svg)](https://pub.dev/packages/flutter_flavor) [![Star on Github](https://img.shields.io/github/stars/lrferreiro/flutter_flavor.svg?style=flat&logo=github&colorB=deeppink&label=stars)](https://pub.dev/packages/flutter_flavor) [![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT) Flavors helps us to create builds for different instances of our app. For example, we can create a flavor for development, a flavor for production and another flavor for a demo of the app. In this way we can create different flavors, and thus have different instances of our apps before publishing it on the App Store and Google Play. flutter_favor allows you to quickly configure and define dynamic variables for each flavor in your project. The `flavors`, as well as their names; they are dynamically defined by the developer or development team. In the configuration of a flavor you can set the `name` of each flavor, as well as the `color` and `location` of its banner. When attribute `name` is undefined or empty, the banner is hidden. You can also configure the banners independently. The aforementioned attributes are globally configured in `FlavorConfig`, but can be changed in the `FlavorBanner`. ## Screenshot | PROD | DEV | TEST | | :-----------------------------: | :----------------------------: | :-----------------------------: | | ![Screenshot Prod](screenshot/flavor_prod.png) | ![Screenshot Dev](screenshot/flavor_dev.png) | ![Screenshot Test](screenshot/flavor_test.png) | **Note** By default the banner is shown in `BannerLocation.topStart` and is visibility only when the attribute `name` of configuration is defined and not empty. ## Getting Started ### Adding package ```yaml flutter_flavor: ^3.1.4 ``` ### Importing package ```dart import 'package:flutter_flavor/flutter_flavor.dart'; ``` ### Configuring ```dart FlavorConfig( name: "DEVELOP", color: Colors.red, location: BannerLocation.bottomStart, variables: { "counter": 0, "baseUrl": "https://www.example.com", } ); ``` ### Using variables ```dart int _counter = FlavorConfig.instance.variables["counter"]; ``` ## Example ### Main ```dart import 'package:flutter/material.dart'; import 'package:flutter_flavor/flutter_flavor.dart'; import 'app.dart'; void main() { FlavorConfig( name: "DEVELOP", color: Colors.red, location: BannerLocation.topStart, variables: { "counter": 5, "baseUrl": "https://www.example2.com", }, ); runApp(const MyApp()); } ``` ### App ```dart import 'package:flutter/material.dart'; import 'package:flutter_flavor/flutter_flavor.dart'; class MyApp extends StatelessWidget { const MyApp({super.key}); @override Widget build(BuildContext context) { return FlavorBanner( child: MaterialApp( title: 'Flutter Demo', theme: ThemeData( colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple), useMaterial3: true, ), home: const MyHomePage(title: 'Flutter Demo Home Page'), ), ); } } class MyHomePage extends StatefulWidget { const MyHomePage({super.key, required this.title}); final String title; @override State createState() => _MyHomePageState(); } class _MyHomePageState extends State { int _counter = 0; void _incrementCounter() { setState(() { _counter++; }); } @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( backgroundColor: Theme.of(context).colorScheme.inversePrimary, title: Text(widget.title), ), body: Center( child: Column( mainAxisAlignment: MainAxisAlignment.center, children: [ const Text( 'You have pushed the button this many times:', ), Text( '$_counter', style: Theme.of(context).textTheme.headlineMedium, ), ], ), ), floatingActionButton: FloatingActionButton( onPressed: _incrementCounter, tooltip: 'Increment', child: const Icon(Icons.add), ), ); } } ``` ## VSCode Configuration The .vscode folder is created in the workspace, if it does not exist it can be created by hand. Inside that folder a launch.json file is created and the configuration is established inside the file. For more information, visit: and ```json { "version": "0.2.0", "configurations": [ { "name": "PROD-Flavor", "program": "[project-folder]/lib/main_prod.dart", "request": "launch", "type": "dart" }, { "name": "DEV-Flavor", "program": "[project-folder]/lib/main_dev.dart", "request": "launch", "type": "dart" } ] } ``` ## License MIT License ## Changelog # Changelog ## 3.1.4 - Upgraded dependencies - Updated example project ## 3.1.3 - Fix FlavorBanner ## 3.1.2 - Migrated to flutter 3.13 ## 3.1.1 - Fix suggestion of best practices - Removed native flavor ## 3.1.0 - Migrated to flutter 3 ## 3.0.4 - Here are the new changes of the issues ## 3.0.3 - Fixed README file ## 3.0.2 - Fixed errors detected and updated README file ## 3.0.1 - Fixed errors detected ## 3.0.0 - Added native flavors settings on Android ## 2.0.0 - Migrated to Null Safety ## 1.1.4 - Added smart text color ## 1.1.3 - Fix README file ## 1.1.2 - Added `color` attribute in `FlavorBanner` for replace the global config of `FlavorConfig`. - Added `location` attribute in `FlavorBanner` for replace the global config of `FlavorConfig`. ## 1.1.1 - Fix pubspec.yml file ## 1.1.0 - Removed static environments ## 1.0.1+2 - Fix README file by ChangJoo-Park - Updated README file ## 1.0.1+1 - Updated and Fix error. ## 1.0.1 - Fix README file. - Added `name` attribute in `FlavorConfig` for replace the default banner name. ## 1.0.0 - Added `location` attribute in `FlavorConfig` for the banner. - Updated README file. ## 0.1.1+1 - Fix example. ## 0.1.1 - Updated the example and added screenshots. ## 0.1.0 - Changed the FlavorBanner widget. - Added example to use the flutter_flavor package. - Added to README file an example to add, configure and use the flutter_flavor package. - Fix bug in the type of the `variables` attribute in `FlavorConfig`. ## 0.0.1 - Initial version