• Y2_823194
  • 5.1MB
  • zip
  • 0
  • VIP专享
  • 0
  • 2022-06-16 01:33
Flutter动态小部件 一个后端驱动的UI工具包,使用json构建动态UI,而json格式与flutter小部件代码非常相似。 从4.0.0-nullsafety.1版本开始,它支持null-safety。 从3.0.0版本开始,它支持将您的flutter代码导出为json代码。 请检查 从1.0.4版本开始,它支持Flutter Web应用程序。 目录 基本信息 我在一家电子商务公司工作。 我们需要构建灵活的页面。 因此,我们定义了一个简单的UI协议,并在Android和iOS上实现。 我们可以通过推送json文件来动态更新App UI。 借助此功能,我们可以进行一些UI A / B测试,而无需将App发布到App Store。 Flutter允许您从单个代码库在iOS和Android上构建漂亮的本机应用程序,还可以稍后再构建Web应用程序。 Flutter的热加载功能可帮助您快速
[![Pub](https://img.shields.io/pub/v/dynamic_widget.svg?color=orange)](https://pub.dev/packages/dynamic_widget)&nbsp; <a href="https://github.com/Solido/awesome-flutter" rel='nofollow' onclick='return false;'> <img alt="Awesome Flutter" src="https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square" /> </a> # Flutter Dynamic Widget >A Backend-Driven UI toolkit, build your dynamic UI with json, and the json format is very similar with flutter widget code. **From 4.0.0-nullsafety.1 version, it supports null-safety.** **From 3.0.0 version, it supports exporting your flutter code to json code. please check [How to write the json code](#how-to-write-the-json-code)** **From 1.0.4 version, it supports flutter web application.** ## Table of contents * [General info](#general-info) * [Screenshots](#screenshots) * [Install](#install) * [Get started](#get-started) * [How to implement a WidgetParser](#how-to-implement-a-widgetparser) * [How to add a click listener](#how-to-add-a-click-listener) * [How to write the json code](#how-to-write-the-json-code) * [Widget Documents](#widget-documents) * [Setup](#setup) * [Contact](#contact) ## General info > I work for an e-commerce company. We need to build flexible pages. So we define a light UI protocol, and implement on Android and iOS. We can dynamic update App UIs by pushing a json file. With this ability, we can do some UI A/B testing without publishing App to app store. Flutter allows you to build beautiful native apps on iOS and Android from a single codebase, it can allow you to build web app later. Flutter's hot reload helps you quickly and easily experiment, build UIs, add features, and fix bugs faster. But it still build native app, the UIs can't be dynamic updated. If you want to modify the UIs, you need to publish the updated app to app store. With this project, you can build your UIs from a json string, which is the UI protocol. The json string is very similar with the Flutter widget dart code. All widget type and widget properties are the same. <img src="https://github.com/dengyin2000/dynamic_widget/raw/master/img/Sample.png" width="800"> Widget type will be a type property, and widget's properties will be the json properties too. All properties and their values will be almost the same. You can checkout the following document. [Currently support flutter widgets and properties](WIDGETS.md) ## Screenshots <img src="https://github.com/dengyin2000/dynamic_widget/raw/master/img/demo1.gif" width="400"> ## Install #### 1. Depend on it Add this to your package's pubspec.yaml file: ``` dependencies: dynamic_widget: ^3.0.3 ``` #### 2. Install it You can install packages from the command line: with Flutter: ``` $ flutter packages get ``` Alternatively, your editor might support `flutter packages get`. Check the docs for your editor to learn more. #### 3. Import it Now in your Dart code, you can use: ```dart import 'package:dynamic_widget/dynamic_widget.dart'; ``` ## Get started You should use `DynamicWidgetBuilder().build` method to covert a json string into flutter widget. It will be time-consuming. so you'd better using `FutureBuilder` to build the UI. ```dart import 'package:dynamic_widget/dynamic_widget.dart'; class PreviewPage extends StatelessWidget { final String jsonString; PreviewPage(this.jsonString); @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( // Here we take the value from the MyHomePage object that was created by // the App.build method, and use it to set our appbar title. title: Text("Preview"), ), body: FutureBuilder<Widget>( future: _buildWidget(context), builder: (BuildContext context, AsyncSnapshot<Widget> snapshot) { if (snapshot.hasError) { print(snapshot.error); } return snapshot.hasData ? SizedBox.expand( child: snapshot.data, ) : Text("Loading..."); }, ), ); } Future<Widget> _buildWidget(BuildContext context) async { return DynamicWidgetBuilder.build(jsonString, context, new DefaultClickListener()); } } ``` ## How to implement a WidgetParser 1. You need to implement the `WidgetParser` abstract class. 2. Add new created WidgetParser by `DynamicWidgetBuilder.addParser(WidgetParser parser)` method. This is a RaisedButton widget parser. ```dart import 'package:dynamic_widget/dynamic_widget/utils.dart'; import 'package:dynamic_widget/dynamic_widget.dart'; import 'package:flutter/material.dart'; class RaisedButtonParser extends WidgetParser { @override String get widgetName => "RaisedButton"; @override Widget parse(Map<String, dynamic> map, BuildContext buildContext, ClickListener listener) { String clickEvent = map.containsKey("click_event") ? map['click_event'] : ""; var raisedButton = RaisedButton( color: map.containsKey('color') ? parseHexColor(map['color']) : null, disabledColor: map.containsKey('disabledColor') ? parseHexColor(map['disabledColor']) : null, disabledElevation: map.containsKey('disabledElevation') ? map['disabledElevation']?.toDouble() : 0.0, disabledTextColor: map.containsKey('disabledTextColor') ? parseHexColor(map['disabledTextColor']) : null, elevation: map.containsKey('elevation') ? map['elevation']?.toDouble() : 0.0, padding: map.containsKey('padding') ? parseEdgeInsetsGeometry(map['padding']) : null, splashColor: map.containsKey('splashColor') ? parseHexColor(map['splashColor']) : null, textColor: map.containsKey('textColor') ? parseHexColor(map['textColor']) : null, child: DynamicWidgetBuilder.buildFromMap(map['child'], buildContext, listener), onPressed: () { listener.onClicked(clickEvent); }, ); return raisedButton; } } ``` Add it to parsers list. ```dart DynamicWidgetBuilder.addParser(RaisedButtonParser()); ``` ## How to add a click listener Add "click_event" property to your widget json definition. for example: ```dart var raisedButton_json = ''' { "type": "Container", "alignment": "center", "child": { "type": "RaisedButton", "color": "##FF00FF", "padding": "8,8,8,8", "textColor": "#00FF00", "elevation" : 8.0, "splashColor" : "#00FF00", "click_event" : "route://productDetail?goods_id=123", "child" : { "type": "Text", "data": "I am a button" } } } ``` We suggest you'd better to use an URI to define the event, as the exmaple, it's a event for going to a product detail page. Then, define a ClickListener ```dart class DefaultClickListener implements ClickListener{ @override void onClicked(String event) { print("Receive click event: " + event); } } ``` Finally, pass the listener to build method. ```dart Future<Widget> _buildWidget() async{ return DynamicWidgetBuilder.build(jsonString, buildContext, new DefaultClickListener()); } ``` ## How to write the json code You don't need to write the json code by hand, you can export your flutter code to json code efficiently with DynamicWidgetJsonExportor widget. You just need to wrap your flutter code with DynamicWidgetJsonExportor widget, then invoke its `exportJsonString()` method, look at following example, click the "export" button, it will find the DynamicWidgetJsonExportor widget, and export its child to json code efficiently. ```dart class _JSONExporterState extends State<JSONExporter> { GlobalKey key = GlobalKey(); @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( // Here we take the value from the MyHomePage object that was created by // the App.build method, and use it to set our appbar title. title: Text("export example"), ), body: Builder( builder: (context) => Column(