advanced_form_generator
Usage
import 'package:advanced_form_generator/widgets/FormFieldItem.dart';
import 'package:advanced_form_generator/widgets/FormFieldSection.dart';
import 'package:advanced_form_generator/advanced_form_generator.dart';
import 'package:advanced_form_generator/widgets/IFormFieldItem.dart';
import 'package:flutter/material.dart';
/// Example of a custom text input
class CustomText extends StatelessWidget implements IFormFieldItem {
@override
TextEditingController? controller;
@override
String? initialValue;
@override
String mapKey;
@override
InputDecoration? decoration;
@override
String label;
CustomText({
Key? key,
this.controller,
this.initialValue,
this.hint,
required this.label,
required this.mapKey,
}) : super(key: key);
@override
Widget build(BuildContext context) {
return TextFormField(
controller: controller,
decoration: decoration,
style: TextStyle(fontSize: 18, color: Colors.grey[900]),
);
}
@override
String? hint;
}
void main() {
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({Key? key}) : super(key: key);
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: const MyHomePage(title: 'Flutter Demo Home Page'),
debugShowCheckedModeBanner: false,
);
}
}
class MyHomePage extends StatefulWidget {
const MyHomePage({Key? key, required this.title}) : super(key: key);
final String title;
@override
State<MyHomePage> createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
final _formKey = GlobalKey<FormState>();
late final AdvancedFormGenerator formGenerator;
@override
void initState() {
formGenerator = AdvancedFormGenerator(
inputs: [
FormFieldItem(
label: 'Name',
required: true,
mapKey: 'name',
),
FormFieldItem(
label: 'E-mail',
mapKey: 'email',
required: true,
validator: (String? value) {
if (value == null || value.isEmpty) {
return 'E-mail is required';
}
return null;
},
),
/// Example of a custom widget
const FormFieldSection(title: 'Security section'),
FormFieldItem(
label: 'Password',
mapKey: 'password',
obscureText: true,
required: true,
),
FormFieldItem(
label: 'Password Confirmation',
mapKey: 'passwordConfirm',
obscureText: true,
required: true,
),
CustomText(
mapKey: 'custom',
label: 'Custom Text Field',
),
],
);
super.initState();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
actions: [
IconButton(
onPressed: () {
if (_formKey.currentState!.validate()) {
debugPrint(formGenerator.toMap().toString());
}
},
icon: const Icon(Icons.save))
],
),
body: Container(
padding: const EdgeInsets.all(10),
width: MediaQuery.of(context).size.width,
height: MediaQuery.of(context).size.height,
child: Form(
key: _formKey,
autovalidateMode: AutovalidateMode.onUserInteraction,
child: Column(
children: formGenerator.render(),
),
),
),
);
}
}
Methods
toMap
Returns a Map with all the fields and their values
Parameters
ignoreEmpty - if true, will ignore empty fields - default: false
emptyValue - value to be used if ignoreEmpty is false and the field is empty - default: false
ignoreEmpty and emptyValue if active together, only ignoreEmpty will be considere
Example
// Declare a form
AdvancedFormGenerator formGenerator = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
]);
// Returns a map with the form's properties and values
**formGenerator.toMap();**
// Example
/*
{
'email': '',
'password: ''
}
*/
render
Returns a List with all the widgets to render
Example
// Declare a form
AdvancedFormGenerator formGenerator = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
]);
...
// Inside widgets
...
Column(
children: formGenerator.render(),
),
...
// or
...
Column(
children: [
Text('Example'),
...formGenerator.render(),
]
),
...
reset
Resets all the TextEditingControllers inside FormFieldItems and IFormFieldItems to empty
Example
AdvancedFormGenerator form = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
initialValue: 'test@email.com'
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
]);
// before reset
Map values = form.toMap();
// {'email': 'test@email.com', password: ''}
// after reset
form.reset();
values = form.toMap();
// {'email': '', password: ''}
getValue
Return a value from the input field with the key, if the key does not exist, null will be returned.
Parameters
key - required, is the same as the mapKey property, passing the key you can get the individual value of a text field.
Example
AdvancedFormGenerator form = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
initialValue: 'test@email.com'
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
]);
String? email = form.getValue('email');
// email = 'test@email.com'
String? password = form.getValue('password');
// password = ''
String? other = form.getValue('other');
// other = null
setValue
Sets a value to the text input if the key passed is valid.
Parameters
key - required, is the same as the mapKey property, passing the key you can get the individual value of a text field.
value - required, is a string field and will be the new value of the text inputis.
Example
AdvancedFormGenerator form = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
initialValue: 'test@email.com'
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
]);
String? email = form.getValue('email');
// email = 'test@email.com'
form.setValue('email', 'email@email.com');
email = form.getValue('email');
// email = 'email@email.com'
How to create a custom FormFieldItem widget
import 'package:advanced_form_generator/widgets/IFormFieldItem.dart';
import 'package:flutter/material.dart';
class CustomText extends StatelessWidget implements IFormFieldItem {
@override
TextEditingController? controller;
@override
String? initialValue;
@override
String mapKey;
@override
InputDecoration? decoration;
@override
String label;
CustomText({
Key? key,
this.controller,
this.initialValue,
this.hint,
required this.label,
required this.mapKey,
}) : super(key: key);
@override
Widget build(BuildContext context) {
return TextFormField(
controller: controller,
decoration: decoration,
style: TextStyle(fontSize: 18, color: Colors.grey[900]),
);
}
@override
String? hint;
}
How to change the style of FormFieldItem?
You can do it individually, like this
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
decoration: InputDecoration(
labelText: 'Email',
labelStyle: TextStyle(fontSize: 18, color: Colors.grey[900]),
border: OutlineInputBorder(
borderRadius: BorderRadius.circular(10),
),
),
)
or for all
AdvancedFormGenerator formGenerator = AdvancedFormGenerator(inputs: [
FormFieldItem(
label: 'E-mail',
required: true,
mapKey: 'email',
),FormFieldItem(
label: 'Senha',
mapKey: 'password',
),
],
decoration: InputDecoration(
labelText: 'Email',
labelStyle: TextStyle(fontSize: 18, color: Colors.grey[900]),
border: OutlineInputBorder(
borderRadius: BorderRadius.circular(10),
),
),
);
Notes
Do not place the FormFieldItem and IFormFieldItem inside any other Widget, or it will not be recognized as a text field.
If you are not using reactive state management, you may need to do a hot reload for changes made to the form code to take effect.
You can change the margin between
FormField Itemby passing the 'margin' parameter in the form's constructor.