blindmonk / fair

A Flutter package used to update widget tree dynamically. Flutter Fair是为Flutter设计的，UI&模板动态化框架

简体中文|English

---

Fair is a lightweight package for Flutter, which can be used to update widget tree and state dynamically. This package is still at an early stage.

We create Fair so we can dispatch any pages changes to users as bundle(s), the way similar to React Native. With Flutter Fair integrated, you can publish your pages without waiting for the next release date of your App. Fair provides standard widget and some logic plugins, it can be used as a new dynamic page or as part of existing Flutter page.

🏛Architecture

🚀 Running

Use Flutter Fair require few steps.

step1：download fair project source code

It is recommended to download fair to the local and dependencies on the relative path.

The download method is as follows:

git clone https://github.com/wuba/fair.git

step2：Add dependency inside pubspec.yaml

Assuming that the fair project and your own project are in the same folder:

# add Fair dependency
dependencies:
  fair: 2.5.0

# add build_runner and compiler dependency
dev_dependencies:
  build_runner: ^2.0.0
  fair_compiler:
    path: ../fair/compiler
 
# switch "fair_version" according to the local Flutter SDK version
# Flutter SDK 2.8.x(2.8.0、2.8.1) -> flutter_2_8_0
# Flutter SDK 2.5.x(2.5.0、2.5.1、2.5.2、2.5.3) -> flutter_2_5_0
# Flutter SDK 2.0.6 -> flutter_2_0_6
# Flutter SDK 1.22.6 -> flutter_1_22_6
dependency_overrides:
  fair_version:
    path: ../fair/flutter_version/flutter_2_8_0

step3：Wrap your app with FairApp Widget

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  FairApp.runApplication(
    _getApp(),
    plugins: {
    },
  );
}

dynamic _getApp() => FairApp(
  modules: {
  },
  delegate: {
  },
  child: MaterialApp(
    home: FairWidget(
            name: 'DynamicWidget',
            path: 'assets/bundle/lib_src_page_dynamic_widget.fair.json',
            data: {"fairProps": json.encode({})}),
  ),
);

step4：Import a dynamic widget as FairWidget

FairWidget(
  name: 'DynamicWidget',
  path: 'assets/bundle/lib_src_page_dynamic_widget.fair.json',
  data: {"fairProps": json.encode({})}),

Documentation

For more details, please refer to https://fair.58.com

versions

2.5.0

updateDate：2022.05.31

Fair

Adapt to flutter SDK 2.8.0, 2.8.1
Dart2js supports parsing singletons
New syntax Sugar.switchCase、Sugar.colorsWithOpacity、Sugar.convertToString, etc

example

Comprehensively optimize the example structure and upgrade the example experience, which is more suitable for beginners.

In the source code, an example project is added to provide the standard usage of fair API.

example location：fair/example

v2.4.1

updateDate：2022.05.12

Fix FairLogger import problem.
Upgrade Analyzer to 2.3.0.

v2.4.0

updateDate：2022.04.26

FlatBuffers supports generating bin files in a null safe environment

v2.3.0

updateDate: 2022.04.22

Fair

supports null-safe
Adapt to Flutter SDK 2.5.0, 2.5.1, 2.5.2, 2.5.3 and other versions

demo

Upgrade the outdated demo in the sample project
Supplement the iOS runtime environment in the sample project

🕰2022 Roadmap

• Major release plan
  • null-safe version support, expected to be launched on April 22 ✅
  • Flutter 2.8.0 version adaptation, expected to be launched in mid-May
  • Flutter 2.10.0 version adaptation, is expected to be launched in early June
  • IDE syntax detection and hint plugin
  • Rich syntactic sugar
• Hot update platform
  • Dart Server project construction ✅
  • Flutter Web project construction ✅
  • Patch/resource management
  • Project management
  • Mobile Update&Download
• Online dynamic
  • Flutter Web project construction ✅
  • Dart Server project construction ✅
  • ActionEdit
  • Code editing
  • Component editing
  • Page editing
  • Engineering editor
  • Flutter effect preview
  • Fair DSL preview

✨Contributors

Thanks goes to these wonderful people (emoji key):

Wu 💻 📖	Penta 💻 📖	haijun 💻 📖	陈有余 💻 📖	yangyang 💻	wan 💻	bujie 💻	Kc 💻
gongpengyang 💻	qixu 💻	waynesonic 💻	paozhuanyinyu 💻	alzzzz 💻 📖	xiangwc 💻	WangYk 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

👏🏻Supporters

License

Copyright (C) 2005-present, 58.com. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the following
  disclaimer in the documentation and/or other materials provided
  with the distribution.
* Neither the name of 58.com nor the names of its
  contributors may be used to endorse or promote products derived
  from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.