smart_forms 1.0.0

  • Readme
  • Changelog
  • Installing
  • new44

Smart Forms #

The idea behind this package is a easy way to build and validate a form with especific field types.

Features #

Field Types #

You have an ENUM which contains the available field types (I will add more progressively). The supported types are:

  • Text
  • Multiline
  • Number
  • Phone
  • E-Mail
  • URL

Input Actions #

You can handle the action to show on the key enter of the keyboard for each field. By now are supported only 3 actions:

  • Next
  • Done
  • Auto (If you use this the plugin will decide considering if this is the last field or not);

Buttons #

In this plugin you can add two buttons that only require the label to show and will be rendered.

  • Submit Button
  • Reset Button

How it works #

You need to generate to types of entitys.

  1. Field Model

    This one contains all the parameters and settings that are available (by now) for the fields of the form. These are:

    • label: String (mandatory)
    • type (Use the enum Types)
    • errorMessage: String
    • required: boolean
    • actions (Use the enum Actions)
    • hint: String
    • validate: boolean
    • maxLength: int
    • password: boolean
    • readOnly: boolean
  2. Form Model

    This is the base of the plugin and contain just a little variables:

    • name: String (mandatory)
    • submitButton: String (mandatory)
    • resetButton: String
    • fields: List of entitys of Field Model

Return Statement #

At the submit of the form you will get a return like this:

{
    "form": "<name of the form submitted>",
    "values": {
        "<field label>": "<value obtained>"
    }
}

[1.0.0] - 2020-05-23. #

The firs release include 6 field types (with many parameters), 2 input actions, submit button, reset Button.

Use this package as a library

1. Depend on it

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


dependencies:
  smart_forms: ^1.0.0

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:smart_forms/smart_forms.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
44
Learn more about scoring.

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

  • Dart: 2.8.1
  • pana: 0.13.8-dev
  • Flutter: 1.17.0

Health issues and suggestions

Document public APIs. (-0.03 points)

58 out of 60 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://github.com/fjbatresv/flutter_smart_forms was unreachable.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and smart_forms.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test