Flutter Forms

Forms are an integral part of all modern mobile and web applications. It is mainly used to interact with the app as well as gather information from the users. They can perform many tasks, which depend on the nature of your business requirements and logic, such as authentication of the user, adding user, searching, filtering, ordering, booking, etc. A form can contain text fields, buttons, checkboxes, radio buttons, etc.

Creating Form

Flutter provides a Form widget to create a form. The form widget acts as a container, which allows us to group and validate the multiple form fields. When you create a form, it is necessary to provide the GlobalKey. This key uniquely identifies the form and allows you to do any validation in the form fields.

The form widget uses child widget TextFormField to provide the users to enter the text field. This widget renders a material design text field and also allows us to display validation errors when they occur.

Let us create a form. First, create a Flutter project and replace the following code in the main.dart file. In this code snippet, we have created a custom class named MyCustomForm. Inside this class, we define a global key as _formKey. This key holds a FormState and can use to retrieve the form widget. Inside the build method of this class, we have added some custom style and use the TextFormField widget to provide the form fields such as name, phone number, date of birth, or just a normal field. Inside the TextFormField, we have used InputDecoration that provides the look and feel of your form properties such as borders, labels, icons, hint, styles, etc. Finally, we have added a button to submit the form.

1. import 'package:flutter/material.dart';  
2.   
3. void main() => runApp(MyApp());  
4.   
5. class MyApp extends StatelessWidget {  
6.   @override  
7.   Widget build(BuildContext context) {  
8.     final appTitle = 'Flutter Form Demo';  
9.     return MaterialApp(  
10.       title: appTitle,  
11.       home: Scaffold(  
12.         appBar: AppBar(  
13.           title: Text(appTitle),  
14.         ),  
15.         body: MyCustomForm(),  
16.       ),  
17.     );  
18.   }  
19. }  
20. // Create a Form widget.  
21. class MyCustomForm extends StatefulWidget {  
22.   @override  
23.   MyCustomFormState createState() {  
24.     return MyCustomFormState();  
25.   }  
26. }  
27. // Create a corresponding State class. This class holds data related to the form.  
28. class MyCustomFormState extends State<MyCustomForm> {  
29.   // Create a global key that uniquely identifies the Form widget  
30.   // and allows validation of the form.  
31.   final _formKey = GlobalKey<FormState>();  
32.   
33.   @override  
34.   Widget build(BuildContext context) {  
35.     // Build a Form widget using the _formKey created above.  
36.     return Form(  
37.       key: _formKey,  
38.       child: Column(  
39.         crossAxisAlignment: CrossAxisAlignment.start,  
40.         children: <Widget>[  
41.           TextFormField(  
42.             decoration: const InputDecoration(  
43.               icon: const Icon(Icons.person),  
44.               hintText: 'Enter your name',  
45.               labelText: 'Name',  
46.             ),  
47.           ),  
48.           TextFormField(  
49.             decoration: const InputDecoration(  
50.               icon: const Icon(Icons.phone),  
51.               hintText: 'Enter a phone number',  
52.               labelText: 'Phone',  
53.             ),  
54.           ),  
55.           TextFormField(  
56.             decoration: const InputDecoration(  
57.             icon: const Icon(Icons.calendar_today),  
58.             hintText: 'Enter your date of birth',  
59.             labelText: 'Dob',  
60.             ),  
61.            ),  
62.           new Container(  
63.               padding: const EdgeInsets.only(left: 150.0, top: 40.0),  
64.               child: new RaisedButton(  
65.                 child: const Text('Submit'),  
66.                   onPressed: null,  
67.               )),  
68.         ],  
69.       ),  
70.     );  
71.   }  
72. }  

Output

Now, run the app, you can see the following screen in your Android Emulator. This form contains three field name, phone number, date of birth, and submit button.

Form validation

Validation is a method, which allows us to correct or confirms a certain standard. It ensures the authentication of the entered data.

Validating forms is a common practice in all digital interactions. To validate a form in a flutter, we need to implement mainly three steps.

Step 1: Use the Form widget with a global key.

Step 2: Use TextFormField to give the input field with validator property.

Step 3: Create a button to validate form fields and display validation errors.

Let us understand it with the following example. In the above code, we have to use validator() function in the TextFormField to validate the input properties. If the user gives the wrong input, the validator function returns a string that contains an error message; otherwise, the validator function return null. In the validator function, make sure that the TextFormField is not empty. Otherwise, it returns an error message.

The validator() function can be written as below code snippets:

1. validator: (value) {  
2.        if (value.isEmpty) {  
3.              return 'Please enter some text';  
4.        }  
5.        return null;  
6. },  

Now, open the main.dart file and add validator() function in the TextFormField widget. Replace the following code with the main.dart file.

1. import 'package:flutter/material.dart';  
2.   
3. void main() => runApp(MyApp());  
4.   
5. class MyApp extends StatelessWidget {  
6.   @override  
7.   Widget build(BuildContext context) {  
8.     final appTitle = 'Flutter Form Demo';  
9.     return MaterialApp(  
10.       title: appTitle,  
11.       home: Scaffold(  
12.         appBar: AppBar(  
13.           title: Text(appTitle),  
14.         ),  
15.         body: MyCustomForm(),  
16.       ),  
17.     );  
18.   }  
19. }  
20. // Create a Form widget.  
21. class MyCustomForm extends StatefulWidget {  
22.   @override  
23.   MyCustomFormState createState() {  
24.     return MyCustomFormState();  
25.   }  
26. }  
27. // Create a corresponding State class, which holds data related to the form.  
28. class MyCustomFormState extends State<MyCustomForm> {  
29.   // Create a global key that uniquely identifies the Form widget  
30.   // and allows validation of the form.  
31.   final _formKey = GlobalKey<FormState>();  
32.   
33.   @override  
34.   Widget build(BuildContext context) {  
35.     // Build a Form widget using the _formKey created above.  
36.     return Form(  
37.       key: _formKey,  
38.       child: Column(  
39.         crossAxisAlignment: CrossAxisAlignment.start,  
40.         children: <Widget>[  
41.           TextFormField(  
42.             decoration: const InputDecoration(  
43.               icon: const Icon(Icons.person),  
44.               hintText: 'Enter your full name',  
45.               labelText: 'Name',  
46.             ),  
47.             validator: (value) {  
48.               if (value.isEmpty) {  
49.                 return 'Please enter some text';  
50.               }  
51.               return null;  
52.             },  
53.           ),  
54.           TextFormField(  
55.             decoration: const InputDecoration(  
56.               icon: const Icon(Icons.phone),  
57.               hintText: 'Enter a phone number',  
58.               labelText: 'Phone',  
59.             ),  
60.             validator: (value) {  
61.               if (value.isEmpty) {  
62.                 return 'Please enter valid phone number';  
63.               }  
64.               return null;  
65.             },  
66.           ),  
67.           TextFormField(  
68.             decoration: const InputDecoration(  
69.             icon: const Icon(Icons.calendar_today),  
70.             hintText: 'Enter your date of birth',  
71.             labelText: 'Dob',  
72.             ),  
73.             validator: (value) {  
74.               if (value.isEmpty) {  
75.                 return 'Please enter valid date';  
76.               }  
77.               return null;  
78.             },  
79.            ),  
80.           new Container(  
81.               padding: const EdgeInsets.only(left: 150.0, top: 40.0),  
82.               child: new RaisedButton(  
83.                 child: const Text('Submit'),  
84.                 onPressed: () {  
85.                   // It returns true if the form is valid, otherwise returns false  
86.                   if (_formKey.currentState.validate()) {  
87.                     // If the form is valid, display a Snackbar.  
88.                     Scaffold.of(context)  
89.                         .showSnackBar(SnackBar(content: Text('Data is in processing.')));  
90.                   }  
91.                 },  
92.               )),  
93.         ],  
94.       ),  
95.     );  
96.   }  
97. }  

Output

Now, run the app. The following screen appears.

In this form, if you left any input field blank, you will get an error message like below screen.