Form submission in Flutter

Introduction

Forms let users enter information in your app. Submitting a form sends that information to be used or saved.

When a user needs to sign up or log in.

When collecting feedback or survey answers.

When entering details like address or payment info.

When searching with filters or criteria.

When sending messages or comments.

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'),
      ),
    ],
  ),
);

Use a GlobalKey to manage the form state.

Call _formKey.currentState!.validate() to check if all fields are valid before submitting.

Examples

A simple form with one text 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 form validity and prints a message when pressed.

Flutter

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

Sample App

This app shows a form with one text field for the user's name. When the user taps Submit, it checks if the field is not empty. If valid, it shows a message greeting the user.

Flutter

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Form Submission Example')),
        body: const Padding(
          padding: EdgeInsets.all(16),
          child: MyForm(),
        ),
      ),
    );
  }
}

class MyForm extends StatefulWidget {
  const MyForm({super.key});

  @override
  State<MyForm> createState() => _MyFormState();
}

class _MyFormState extends State<MyForm> {
  final _formKey = GlobalKey<FormState>();
  final _controller = TextEditingController();

  @override
  void dispose() {
    _controller.dispose();
    super.dispose();
  }

  void _submit() {
    if (_formKey.currentState!.validate()) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('Hello, ${_controller.text}!')),
      );
    }
  }

  @override
  Widget build(BuildContext context) {
    return Form(
      key: _formKey,
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          TextFormField(
            controller: _controller,
            decoration: const InputDecoration(
              labelText: 'Enter your name',
            ),
            validator: (value) {
              if (value == null || value.isEmpty) {
                return 'Please enter your name';
              }
              return null;
            },
          ),
          const SizedBox(height: 16),
          ElevatedButton(
            onPressed: _submit,
            child: const Text('Submit'),
          ),
        ],
      ),
    );
  }
}

Important Notes

Always dispose of controllers to free resources.

Use ScaffoldMessenger to show messages after submission.

Validators help ensure users enter correct data before submitting.

Summary

Forms collect user input and need validation before submission.

Use a GlobalKey<FormState> to manage form state.

Show feedback to users after they submit the form.

Practice

1. What is the main purpose of using a Form widget in Flutter when collecting user input?

easy

A. To create animations for buttons

B. To display images inside the app

C. To group multiple input fields and manage their validation together

D. To handle network requests automatically

Solution

1. Step 1: Understand the role of Form widget

   The Form widget groups input fields and helps manage their validation as a single unit.

2. Step 2: Identify the correct purpose

   Other options describe unrelated features like images, animations, or network handling.

3. Final Answer:

   To group multiple input fields and manage their validation together -> Option C

4. Quick Check:

   Form groups inputs for validation = A [OK]

Hint: Form widget groups inputs for validation and submission [OK]

Common Mistakes:

• Thinking Form handles images or animations
• Confusing Form with network handling widgets
• Ignoring validation grouping

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

easy

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

B. final _formKey = GlobalKey();

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

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

Solution

1. Step 1: Recall the correct type for form key

   The form key must be typed as GlobalKey<FormState> to access form validation methods.

2. Step 2: Check each option's type

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

3. Final Answer:

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

4. Quick Check:

   Form key type = GlobalKey<FormState> [OK]

Hint: Use GlobalKey<FormState> to manage form state [OK]

Common Mistakes:

• Omitting <FormState> generic type
• Using GlobalKey<Form> instead of FormState
• Using untyped GlobalKey

3. Given this Flutter code snippet:

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: TextFormField(
    validator: (value) {
      if (value == null || value.isEmpty) {
        return 'Enter text';
      }
      return null;
    },
  ),
);

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

What will be printed if the user submits the form with an empty text field?

medium

A. Invalid input

B. No output

C. Valid input

D. Runtime error

Solution

1. Step 1: Analyze the validator function

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

2. Step 2: Check the validate() method result

   Since validator returns a non-null string, validate() returns false, triggering the else branch.

3. Final Answer:

   Invalid input -> Option A

4. Quick Check:

   Empty input fails validation = Invalid input [OK]

Hint: Validator returning non-null means invalid input [OK]

Common Mistakes:

• Assuming empty input is valid
• Confusing validator return values
• Expecting no output on validation failure

4. Consider this Flutter code snippet for form submission:

final _formKey = GlobalKey<FormState>();

Form(
  key: _formKey,
  child: TextFormField(
    validator: (value) {
      if (value == null || value.isEmpty) {
        return 'Required';
      }
      return null;
    },
  ),
);

ElevatedButton(
  onPressed: () {
    if (_formKey.currentState.validate()) {
      print('Submitted');
    }
  },
  child: const Text('Submit'),
);

What is the error in this code?

medium

A. currentState can be null, should use currentState! to avoid error

B. validate() should be validate without parentheses

C. Validator function must return a boolean, not a string

D. TextFormField missing controller property

Solution

1. Step 1: Check usage of currentState

   currentState can be null if the form is not mounted, so calling validate() without null check causes error.

2. Step 2: Identify correct null safety usage

   Using _formKey.currentState!.validate() asserts non-null and avoids runtime error.

3. Final Answer:

   currentState can be null, should use currentState! to avoid error -> Option A

4. Quick Check:

   Use currentState! to safely call validate() [OK]

Hint: Use currentState! to avoid null errors on validate() [OK]

Common Mistakes:

• Calling validate() without null check
• Thinking validator returns boolean
• Misusing validate as property

5. You want to submit a form and show a success message only if all fields are valid. Which Flutter code snippet correctly performs this action?

hard

A. if (_formKey.currentState.validate) {
print('Success!');
}

B. if (_formKey.currentState!.validate()) {
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(content: Text('Success!'))
);
}

C. if (_formKey.validate()) {
showDialog(context: context, builder: (_) => Text('Success!'));
}

D. if (_formKey.currentState!.validate()) {
Navigator.pushNamed(context, '/success');
}

Solution

1. Step 1: Validate form state correctly

   Use _formKey.currentState!.validate() to check all fields are valid.

2. Step 2: Show success feedback

   Use ScaffoldMessenger.of(context).showSnackBar() to display a success message to the user.

3. Step 3: Check other options

   if (_formKey.currentState.validate) { print('Success!'); } misses parentheses and null safety, C uses invalid method, D navigates instead of showing message.

4. Final Answer:

   if (_formKey.currentState!.validate()) { ScaffoldMessenger.of(context).showSnackBar( SnackBar(content: Text('Success!')) ); } -> Option B

5. Quick Check:

   Validate then show SnackBar for success [OK]

Hint: Validate with currentState! then show SnackBar for feedback [OK]

Common Mistakes:

• Calling validate without parentheses or null check
• Using invalid methods on form key
• Showing message without ScaffoldMessenger