remote_form 0.0.2

  • Readme
  • Changelog
  • Example
  • Installing
  • 47

remote_form #

Flutter widget to manage a form from a JSON definition

Usage #

Add the factory to the RemoteManagerWidget:

RemoteForm(
    obSubmit: (values, {associatedData}){}, 
    onChanges: (key, value, {associatedData}) => debugPrint('$key change to $value'),
    definition: {},
    child: RemoteWidget(...)
)

Then you can provide a JSON representation of a color picker like this:

{
    'type': 'image_button',
    'id': 'myButton',
    'value': 'on',
    'values': {
      'on': 'http://chittagongit.com/download/17966',
      'off': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQRS1i8ftLBJX74FnwordRN5vQ5IgUy9rjkR1R2ODiBjWZThKoEHA',
    }
}

API #

Image button:

id : id of the widget value : current value, it has to match one of the values entries width : width of the button height: height of the button fit: fit, default to contain (1), see BoxFit for more padding: padding of the button, see EdgeInsets definition values: map of possible value

How it works #

Under the hood remote_ui does his magic to transform JSON into widget tree and forward changes to remote_form.

[0.0.2] - 05/10/2019. #

  • add validator provider to check form from outside.

[0.0.1] - 05/06/2019. #

  • initial release.

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:remote_form/remote_form.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.stretch,
          children: <Widget>[
            Expanded(
              child: RemoteForm(
                onSubmit: (values, {associatedData}) {
                  debugPrint('form submitted $values');
                },
                onChanges: (key, value, {associatedData}) => debugPrint('$key change to $value'),
                definition: {
                  'type': 'column',
                  'padding': 16,
                  'crossAxisAlignment': CrossAxisAlignment.stretch.index,
                  'children': [
                    {
                      'type': 'dropdown_button',
                      'id': 'gender',
                      'hint': {
                        'type': 'text',
                        'text': 'Gender',
                      },
                      'isExpanded': true,
                      'items': {0: 'Male', 1: 'Female', 2: 'None'}
                    },
                    {
                      'type': 'text_field',
                      'id': 'name',
                      'required': true,
                      'textInputAction': TextInputAction.next.index,
                      'decoration': {
                        'labelText': 'Name*',
                      }
                    },
                    {
                      'type': 'text_field',
                      'id': 'firstname',
                      'textInputAction': TextInputAction.next.index,
                      'decoration': {
                        'labelText': 'First name',
                      }
                    },
                    {
                      'type': 'text_field',
                      'id': 'phone',
                      'keyboardType': TextInputType.phone.index,
                      'textInputAction': TextInputAction.next.index,
                      'validator': '^[0-9+]{8,10}\$',
                      'decoration': {
                        'labelText': 'Phone',
                      }
                    },
                    {
                      'type': 'text_field',
                      'id': 'email',
                      'keyboardType': TextInputType.emailAddress.index,
                      'textInputAction': TextInputAction.done.index,
                      'validator': '[a-zA-Z0-9]+@[a-zA-Z0-9]+\\.[a-zA-Z]+',
                      'validatorErrorMessage': 'Email invalid',
                      'decoration': {
                        'labelText': 'Email',
                      }
                    },
                    {
                      'type': 'raised_button',
                      'id': 'submit',
                      'child': {
                        'type': 'text',
                        'text': 'Submit',
                      }
                    }
                  ],
                },
              ),
            ),
          ],
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  remote_form: ^0.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:remote_form/remote_form.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
8
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
64
Overall:
Weighted score of the above. [more]
47
Learn more about scoring.

We analyzed this package on Jul 2, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.9+1
  • Flutter: 1.17.3

Analysis suggestions

Package not compatible with SDK dart

because of import path [remote_form]

Health suggestions

Fix lib/src/remote_form.dart. (-0.50 points)

Analysis of lib/src/remote_form.dart reported 1 hint:

line 95 col 20: 'inheritFromWidgetOfExactType' is deprecated and shouldn't be used. Use dependOnInheritedWidgetOfExactType instead. This feature was deprecated after v1.12.1..

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (flutter_hooks).

The package description is too short. (-16 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.2 <3.0.0
flutter 0.0.0
flutter_hooks ^0.6.0 0.6.1 0.10.0
remote_ui ^0.0.5 0.0.7 0.0.8
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.0
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test