Ephenodrom/Flutter-Global-Config
A flutter package for managing different configurations and making them available everythere inside the app.
gehe zu github herunterladenFlutter Global Configuration
A flutter package for managing different configurations by merging them together and making
them available everythere inside the app via a singleton.
Table of Contents
- Flutter Global Configuration
Preamble
This package is also part of the EZ Flutter Framework.
Install
pubspec.yaml
Update pubspec.yaml and add the following line to your dependencies.
dependencies:
global_configuration: ^2.0.0
Import
Import the package with :
import 'package:global_configuration/global_configuration.dart';
Loading configuration
There are many ways where you can store your configuration files and load them.
Load from asset
Creating a configuration file inside assets/cfg folder
Create a .json file and place it under assets/cfg/
Example filename: assets/cfg/app_settings.json
{
"key1": "value1",
"key2": "value2"
}
Remember to update your pubspec.yaml file, so the config can be loaded from the assets directory!
The config files must be placed under the assets/cfg/ directory.
flutter:
assets:
- assets/cfg/
Load configuration from assets at app start
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
void main() async{
await GlobalConfiguration().loadFromAsset("app_settings");
runApp(MyApp());
}
class MyApp extends StatelessWidget {
...
}
Load from path
Creating a configuration file anywhere
Create a file anywhere inside your app.
Load configuration from path at app start
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
void main() async {
await GlobalConfiguration().loadFromPath("/path/file.json");
runApp(MyApp());
}
class MyApp extends StatelessWidget {
...
}
Load from path into key
The same as loadFromPath, but the config is added under the given key.
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
void main() async {
await GlobalConfiguration().loadFromPathIntoKey("/path/file.json", "env_settings");
runApp(MyApp());
}
class MyApp extends StatelessWidget {
...
}
Load from map
Creating a configuration inside .dart file
Create a dart file which includes your configuration and import it in your main file.
Example filename: /config/app_settings.config.dart
final Map<String, String> appSettings = {
"key1": "value1",
"key2": "value2"
};
Load configuration from map at app start
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
import 'config/app_settings.config.dart';
void main() async {
GlobalConfiguration().loadFromMap(appSettings);
runApp(MyApp());
}
class MyApp extends StatelessWidget {
...
}
Load from url
It is possible to load any json configuration file from a url. Use the method loadFromUrl to load
the config via GET request.
Please consider using a try / catch. This method will throw an exception if the status code of the
GET request is not 200.
The method also accepts query parameters and headers! The header “Accept: application/json” is always
included.
Load configuration from url at app start
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
void main() async{
try{
await GlobalConfiguration().loadFromUrl("http://urlToMyConfig.com");
}catch(e){
// something went wrong while fetching the config from the url ... do something
}
runApp(MyApp());
}
class MyApp extends StatelessWidget {
...
}
Using the configuration in your app
Instatiate the GlobalConfiguration class and call any get($key) method.
import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
class CustomWidget extends StatelessWidget {
CustomWiget(){
// Access the config in the constructor
print(GlobalConfiguration().getString("key1")); // prints value1
}
@override
Widget build(BuildContext context) {
// Access the config in the build method
return Text(GlobalConfiguration().getString("key2")); // prints value2
}
}
Overriding configuration
Sometimes it is necessary to override data in the configuration. This can be done by the updateValue method.
This method makes a check for the given type of the value and then performs an update the configuration map.
Map<String, String> appSettings = {
"key1": "value1",
"key2": 1
};
GlobalConfiguration().loadFromMap(appSettings); // loading the configuration
print(GlobalConfiguration().getString("key1")); // output : value1
print(GlobalConfiguration().getString("key2")); // output : 1
GlobalConfiguration().updateValue("key1", "value2"); // update the value for key1
GlobalConfiguration().updateValue("key2", 2); // update the value for key2
print(GlobalConfiguration().getString("key1")); // output : value2
print(GlobalConfiguration().getString("key2")); // output : 2
Full example
You can find a full example in the example folder.
Changelog
For a detailed changelog, see the CHANGELOG.md file
Copyright and license
MIT License
Copyright © 2023 Ephenodrom
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
![](/images/banner-woo.jpg)
herausragende projekte, die mit Ephenodrom/Flutter-Global-Config zusammenhängen, empfohlener download
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple
getwidget
4416
Most popular and easy to use open source UI library with 1000+ Widgets to build flutter app.