Form widget and GlobalKey in Flutter

Introduction

A Form widget helps group input fields together to manage their validation and saving easily. A GlobalKey lets you access the form's state from anywhere in your code.

When you want to collect user input like name, email, or password.

When you need to check if all inputs are valid before submitting.

When you want to reset or save the form data programmatically.

When you want to show error messages for invalid inputs.

When you want to control the form from outside its widget tree.

Syntax

Flutter

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: Column(
    children: [
      TextFormField(
        validator: (value) {
          if (value == null || value.isEmpty) {
            return 'Please enter some text';
          }
          return null;
        },
      ),
      ElevatedButton(
        onPressed: () {
          if (_formKey.currentState!.validate()) {
            // Process data
          }
        },
        child: Text('Submit'),
      ),
    ],
  ),
)

The GlobalKey<FormState> uniquely identifies the form and lets you call methods like validate() or save().

The validator function returns a string error message if input is invalid, or null if valid.

Examples

A simple form with one input field and a validator that checks if the field is empty.

Flutter

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: TextFormField(
    validator: (value) => (value ?? '').isEmpty ? 'Enter text' : null,
  ),
)

Button that checks if the form inputs are valid when pressed.

Flutter

ElevatedButton(
  onPressed: () {
    if (_formKey.currentState!.validate()) {
      print('Form is valid');
    } else {
      print('Form is invalid');
    }
  },
  child: Text('Check'),
)

Form with a length check validator and a button that saves the form if valid.

Flutter

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: Column(
    children: [
      TextFormField(
        validator: (value) => (value ?? '').length < 3 ? 'Too short' : null,
      ),
      ElevatedButton(
        onPressed: () {
          if (_formKey.currentState!.validate()) {
            _formKey.currentState!.save();
          }
        },
        child: Text('Submit'),
      ),
    ],
  ),
)

Sample App

This app shows a form with one text input for a name. When you press Submit, it checks if the name is empty. If valid, it shows a message greeting the user.

Flutter

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  final _formKey = GlobalKey<FormState>();
  final TextEditingController _controller = TextEditingController();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Form and GlobalKey Example')),
        body: Padding(
          padding: EdgeInsets.all(16),
          child: Form(
            key: _formKey,
            child: Column(
              children: [
                TextFormField(
                  controller: _controller,
                  decoration: InputDecoration(labelText: 'Enter your name'),
                  validator: (value) {
                    if (value == null || value.isEmpty) {
                      return 'Name cannot be empty';
                    }
                    return null;
                  },
                ),
                SizedBox(height: 20),
                ElevatedButton(
                  onPressed: () {
                    if (_formKey.currentState!.validate()) {
                      ScaffoldMessenger.of(context).showSnackBar(
                        SnackBar(content: Text('Hello, ${_controller.text}!')),
                      );
                    }
                  },
                  child: Text('Submit'),
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}

Important Notes

Always assign a GlobalKey<FormState> to your form to control it.

Use _formKey.currentState!.validate() to check all validators at once.

You can call _formKey.currentState!.save() to save form data after validation.

Summary

The Form widget groups input fields for easy validation and saving.

A GlobalKey lets you access the form's state anywhere in your code.

Use validators to check input and show error messages automatically.

Practice

1. What is the main purpose of using a Form widget in Flutter?

easy

A. To group multiple input fields for validation and saving

B. To create a button that submits data

C. To display images in a grid layout

D. To manage app navigation between screens

Solution

1. Step 1: Understand the role of Form widget

   The Form widget groups input fields so you can validate and save them together.

2. Step 2: Compare options with Form's purpose

   Only To group multiple input fields for validation and saving describes grouping input fields for validation and saving, which is the Form's main use.

3. Final Answer:

   To group multiple input fields for validation and saving -> Option A

4. Quick Check:

   Form groups inputs = D [OK]

Hint: Form groups inputs for validation and saving [OK]

Common Mistakes:

• Thinking Form is for navigation or layout
• Confusing Form with buttons or images
• Assuming Form manages app state globally

2. Which of the following is the correct way to declare a GlobalKey for a Form in Flutter?

easy

A. final _formKey = GlobalKey();

B. final _formKey = GlobalKey<FormState>();

C. final _formKey = GlobalKey<Form>();

D. final _formKey = GlobalKey<State>();

Solution

1. Step 1: Identify correct GlobalKey type for Form

   The GlobalKey must be typed as GlobalKey<FormState> to access the Form's state.

2. Step 2: Check each option's type

   final _formKey = GlobalKey<FormState>(); uses GlobalKey<FormState>(), which is correct. Others use wrong or incomplete types.

3. Final Answer:

   final _formKey = GlobalKey<FormState>(); -> Option B

4. Quick Check:

   GlobalKey typed as FormState = A [OK]

Hint: GlobalKey must be typed as GlobalKey<FormState>() [OK]

Common Mistakes:

• Using GlobalKey without type parameter
• Using GlobalKey<Form> instead of FormState
• Using GlobalKey<State> which is too generic

3. Given this Flutter code snippet:

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: TextFormField(
    validator: (value) => value!.isEmpty ? 'Enter text' : null,
  ),
);

// Later in code
if (_formKey.currentState!.validate()) {
  print('Valid input');
} else {
  print('Invalid input');
}

What will be printed if the TextFormField is empty when validate() is called?

medium

A. Valid input

B. No output, code throws error

C. Invalid input

D. Nothing happens, validate() returns null

Solution

1. Step 1: Understand validator behavior

   The validator returns 'Enter text' if the field is empty, which means validation fails.

2. Step 2: Check validate() result

   validate() returns false if any validator returns a non-null string, so the else branch runs.

3. Final Answer:

   Invalid input -> Option C

4. Quick Check:

   Empty input triggers validator error = B [OK]

Hint: Validator returns error string means validate() is false [OK]

Common Mistakes:

• Assuming validate() returns true on empty input
• Confusing validator return null with error
• Thinking validate() throws error on empty input

4. Identify the error in this Flutter code snippet:

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: TextFormField(
    validator: (value) {
      if (value!.length < 3) return 'Too short';
      return null;
    },
  ),
);

// Later
if (_formKey.currentState.validate()) {
  print('Valid');
}

medium

A. GlobalKey should be GlobalKey<Form>

B. Validator should return a boolean, not a string

C. Missing exclamation mark after currentState

D. Calling validate() without null check on currentState

Solution

1. Step 1: Check usage of currentState

   currentState can be null if Form is not mounted, so calling validate() without null check risks error.

2. Step 2: Review code for null safety

   The code calls _formKey.currentState.validate() without ! or ?. which causes a compile error in null-safe Dart.

3. Final Answer:

   Calling validate() without null check on currentState -> Option D

4. Quick Check:

   currentState may be null, needs ! or ? = A [OK]

Hint: Always null-check currentState before validate() [OK]

Common Mistakes:

• Forgetting to add ! after currentState
• Returning boolean from validator instead of string/null
• Using wrong GlobalKey type

5. You want to create a form with two TextFormFields and a submit button. You want to validate both fields and show errors if empty. Which approach correctly uses GlobalKey and Form to achieve this?

hard

A. Declare a GlobalKey<FormState>, assign it to Form's key, use validators on fields, call _formKey.currentState!.validate() on submit

B. Use separate GlobalKeys for each TextFormField and call validate() on each key

C. Use a GlobalKey without type parameter and call validate() on it

D. Wrap each TextFormField in its own Form widget with separate GlobalKeys

Solution

1. Step 1: Understand Form and GlobalKey usage

   One GlobalKey<FormState> is used to manage the whole Form and validate all fields together.

2. Step 2: Evaluate options for best practice

   Declare a GlobalKey<FormState>, assign it to Form's key, use validators on fields, call _formKey.currentState!.validate() on submit correctly uses one GlobalKey<FormState>, assigns it to Form, uses validators, and calls validate() once.

3. Final Answer:

   Declare a GlobalKey<FormState>, assign it to Form's key, use validators on fields, call _formKey.currentState!.validate() on submit -> Option A

4. Quick Check:

   Single GlobalKey<FormState> for whole Form = C [OK]

Hint: Use one GlobalKey<FormState> for entire Form [OK]

Common Mistakes:

• Using multiple GlobalKeys for each field
• Not typing GlobalKey as FormState
• Wrapping each field in separate Form widgets