Flutter FormBuilder - flutter_form_builder
This package helps in generation of forms in Flutter by providing the syntactic sugar for creating a Form Widget and reduce the boilerplate needed to build a form, validate fields, react to changes, and collect the value of the Form in the form of a map.
Simple Usage
To use this plugin, add flutter_form_builder
as a dependency in your pubspec.yaml file.
Example
final GlobalKey<FormBuilderState> _fbKey = GlobalKey<FormBuilderState>();
Note: Avoid defining the GlobalKey inside your build method because this will create a new GlobalKey on every build cycle bringing about some erratic behavior.
Column(
children: <Widget>[
FormBuilder(
key: _fbKey,
autovalidate: true,
child: Column(
children: <Widget>[
FormBuilderDateTimePicker(
attribute: "date",
inputType: InputType.date,
format: DateFormat("yyyy-MM-dd"),
decoration:
InputDecoration(labelText: "Appointment Time"),
),
FormBuilderSlider(
attribute: "slider",
validators: [FormBuilderValidators.min(6)],
min: 0.0,
max: 10.0,
initialValue: 1.0,
divisions: 20,
decoration:
InputDecoration(labelText: "Number of somethings"),
),
FormBuilderCheckbox(
attribute: 'accept_terms',
initialValue: false,
label: Text(
"I have read and agree to the terms and conditions"),
validators: [
FormBuilderValidators.requiredTrue(
errorText:
"You must accept terms and conditions to continue",
),
],
),
FormBuilderDropdown(
attribute: "gender",
decoration: InputDecoration(labelText: "Gender"),
// initialValue: 'Male',
hint: Text('Select Gender'),
validators: [FormBuilderValidators.required()],
items: ['Male', 'Female', 'Other']
.map((gender) => DropdownMenuItem(
value: gender,
child: Text("$gender")
)).toList(),
),
FormBuilderTextField(
attribute: "age",
decoration: InputDecoration(labelText: "Age"),
validators: [
FormBuilderValidators.numeric(),
FormBuilderValidators.max(70),
],
),
FormBuilderRadio(
decoration: InputDecoration(labelText: 'My chosen language'),
leadingInput: true,
attribute: "best_language",
validators: [FormBuilderValidators.required()],
options: [
"Dart",
"Kotlin",
"Java",
"Swift",
"Objective-C"
]
.map((lang) => FormBuilderFieldOption(value: lang))
.toList(growable: false),
),
FormBuilderSegmentedControl(
decoration:
InputDecoration(labelText: "Movie Rating (Archer)"),
attribute: "movie_rating",
options: List.generate(5, (i) => i + 1)
.map(
(number) => FormBuilderFieldOption(value: number))
.toList(),
),
FormBuilderSwitch(
label: Text('I Accept the tems and conditions'),
attribute: "accept_terms_switch",
initialValue: true,
),
FormBuilderStepper(
decoration: InputDecoration(labelText: "Stepper"),
attribute: "stepper",
initialValue: 10,
step: 1,
),
FormBuilderRate(
decoration: InputDecoration(labelText: "Rate this form"),
attribute: "rate",
iconSize: 32.0,
initialValue: 1,
max: 5,
),
FormBuilderCheckboxList(
decoration:
InputDecoration(labelText: "The language of my people"),
attribute: "languages",
initialValue: ["Dart"],
options: [
FormBuilderFieldOption(value: "Dart"),
FormBuilderFieldOption(value: "Kotlin"),
FormBuilderFieldOption(value: "Java"),
FormBuilderFieldOption(value: "Swift"),
FormBuilderFieldOption(value: "Objective-C"),
],
),
FormBuilderSignaturePad(
decoration: InputDecoration(labelText: "Signature"),
attribute: "signature",
height: 100,
),
],
),
),
Row(
children: <Widget>[
MaterialButton(
child: Text("Submit"),
onPressed: () {
_fbKey.currentState.save();
if (_fbKey.currentState.validate()) {
print(_fbKey.currentState.value);
}
},
),
MaterialButton(
child: Text("Reset"),
onPressed: () {
_fbKey.currentState.reset();
},
),
],
)
],
)
Input widgets
The currently supported fields include:
FormBuilderCheckbox
- Single Checkbox fieldFormBuilderCheckboxList
- List of Checkboxes for multiple selectionFormBuilderChipsInput
- Takes a list ofChip
s as inputFormBuilderDateTimePicker
- For Date, Time and DateTime inputFormBuilderDropdown
- Allow selection of one value from a list as a DropdownFormBuilderRadio
- Allow selection of one value from a list of Radio WidgetsFormBuilderRate
- For selection of a numerical value as a ratingFormBuilderSegmentedControl
- For selection of a value from theCupertinoSegmentedControl
as an inputFormBuilderSignaturePad
- Presents a drawing pad on which user can doodleFormBuilderSlider
- For selection of a numerical value on a sliderFormBuilderStepper
- Selection of a number by tapping on a plus or minus symbolFormBuilderSwitch
- On/Off switchFormBuilderTextField
- For text input. Allows input of single-line text, multi-line text, password, email, urls etc by using different configurations and validatorsFormBuilderTypeAhead
- Auto-completes user input from a list of items
In order to create an input field in the form, along with the label, and any applicable validation, there are several attributes that are supported by all types of inputs namely:
Attribute | Type | Default | Required | Description |
---|---|---|---|---|
attribute | String | null | true | This will form the key in the form value Map |
initialValue | dynamic | null | false | The initial value of the input field |
readonly | bool | false | false | Determines whether the field widget will accept user input. This value will be ignored if the readonly attribute of FormBuilder widget is set to true |
decoration | InputDecoration | InputDecoration() | false | |
validators | List<FormFieldValidator> | [] | false | List of FormFieldValidator s that will check the validity of value candidate in the FormField |
onChanged | ValueChanged<T> | null | false | This event function will fire immediately the the field value changes |
valueTransformer | ValueTransformer<T> | null | false | Function that transforms field value before saving to form value. e.g. transform TextField value for numeric field from String to num |
The rest of the attributes will be determined by the type of Widget being used. |
Building your own custom field
To build your own field within a FormBuilder
, we use FormBuilderCustomField
which will require that you define your own FormField
.
The FormField
will not require a validator
if the validators
property is already defined in the FormBuilderCustomField
.
FormBuilderCustomField(
attribute: "name",
validators: [
FormBuilderValidators.required(),
],
formField: FormField(
enabled: true,
builder: (FormFieldState<dynamic> field) {
return InputDecorator(
decoration: InputDecoration(
labelText: "Select option",
contentPadding:
EdgeInsets.only(top: 10.0, bottom: 0.0),
border: InputBorder.none,
),
child: DropdownButton(
isExpanded: true,
items: ["One", "Two"].map((option) {
return DropdownMenuItem(
child: Text("$option"),
value: option,
);
}).toList(),
value: field.value,
onChanged: (value) {
field.didChange(value);
},
),
);
},
),
),
Validation
The validators
attribute in fields take in any number of FormFieldValidator
allowing composability
of validation functions as well as allow reusability of already defined validator methods.
Built-in Validators
The package comes with several most common FormFieldValidator
s such as required, numeric, mail, URL, min,
max, minLength, maxLength, IP, credit card etc. with default errorText
in English but with
ability to include you own error message that will display whenever validation fails.
Validation example:
FormBuilderTextField(
attribute: "age",
decoration: InputDecoration(labelText: "Age"),
validators: [
FormBuilderValidators.numeric(errorText: "La edad debe ser numérica."),
FormBuilderValidators.max(70),
],
),
Custom validator function
As well as the built-in validators any function of type FormFieldValidator
will be accepted into the list of validators
.
FormBuilderTextField(
attribute: "over_18",
decoration: InputDecoration(labelText: "Are you over 18?"),
validators: [
FormBuilderValidators.required(),
(val){
if(val.toLowerCase() != "yes")
return "The answer must be Yes";
},
],
),
Conditional validation
You can now validate a field based on the value of another field
FormBuilderRadio(
decoration: InputDecoration(labelText: 'My best language'),
attribute: "best_language",
validators: [FormBuilderValidators.required()],
options: [
"Dart",
"Kotlin",
"Java",
"Swift",
"Objective-C",
"Other"
]
.map((lang) => FormBuilderFieldOption(value: lang))
.toList(growable: false),
),
FormBuilderTextField(
attribute: "specify",
decoration: InputDecoration(labelText: "If Other, please specify"),
validators: [
(val){
if(_fbKey.currentState.fields['best_language'].currentState.value == "Other" && (val == null || val.isEmpty))
return "Kindly specify your language";
},
],
),
CREDITS
This package is dependent on the following packages and plugins:
- flutter_typeahead by AbdulRahmanAlHamali
- sy_flutter_widgets by Li Shuhao
- datetime_picker_formfield by Jacob Phillips
- validators by dart-league
- intl - Dart Package
- The SignaturePad is based on signature by 4Q s.r.o. with some minor improvements to fit our usage
- flutter_chips_input by Yours trully :)
TODO:
Improvements
X
Allow addition of custom input typesX
Improve documentation by showing complete list of input types and their usage and optionsX
Create atransformer
function option that will convert field value when field id saved - can be used to convert string to number, change to uppercase etc.X
Assert no duplicates inFormBuilderInput
sattribute
namesX
Allow options for Checkboxes and Radios to appear left or right - Done vialeadingInput
by Sven Schöne
New FormBuilder inputs
X
SignaturePad - Based on https://pub.dartlang.org/packages/signature
KNOWN ISSUES
Form's reset()
doesn't clear SignaturePad - You'll be forced to clear manually
Support
If this package was helpful to you in delivering on your project or you just wanna to support this project, a cup of coffee would be highly appreciated ;-)
Libraries
Dart
- dart:ui
- Built-in types and core primitives for a Flutter application. [...]
- dart:async
- Support for asynchronous programming, with classes such as Future and Stream. [...]
- dart:collection
- Classes and utilities that supplement the collection support in dart:core. [...]
- dart:convert
- Encoders and decoders for converting between different data representations, including JSON and UTF-8. [...]
- dart:core
- Built-in types, collections, and other core functionality for every Dart program. [...]
- dart:developer
- Interact with developer tools such as the debugger and inspector. [...]
- dart:math
- Mathematical constants and functions, plus a random number generator. [...]
- dart:typed_data
- Lists that efficiently handle fixed sized data (for example, unsigned 8 byte integers) and SIMD numeric types. [...]
- dart:io
- File, socket, HTTP, and other I/O support for non-web applications. [...]
- dart:isolate
- Concurrent programming using isolates: independent workers that are similar to threads but don't share memory, communicating only via messages. [...]