Named routes in Flutter

Introduction

Named routes help you move between screens easily by giving each screen a simple name. This makes your app navigation clear and organized.

When your app has multiple screens and you want to switch between them clearly.

When you want to avoid writing long code to open new screens.

When you want to keep your navigation code clean and easy to read.

When you want to reuse screen names to navigate from different parts of your app.

Syntax

Flutter

MaterialApp(
  initialRoute: '/home',
  routes: {
    '/home': (context) => HomeScreen(),
    '/settings': (context) => SettingsScreen(),
  },
)

initialRoute sets the first screen shown when the app starts.

routes is a map where keys are route names and values are functions returning the screen widgets.

Examples

This code moves the user to the screen named '/settings'.

Flutter

Navigator.pushNamed(context, '/settings');

Defines two named routes: '/' for home and '/profile' for profile screen.

Flutter

MaterialApp(
  initialRoute: '/',
  routes: {
    '/': (context) => HomeScreen(),
    '/profile': (context) => ProfileScreen(),
  },
)

This code goes back to the previous screen in the navigation stack.

Flutter

Navigator.pop(context);

Sample App

This app starts at the Home screen. Pressing the button moves to the About screen using a named route. The About screen has a button to go back.

Flutter

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      initialRoute: '/',
      routes: {
        '/': (context) => HomeScreen(),
        '/about': (context) => AboutScreen(),
      },
    );
  }
}

class HomeScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Home')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            Navigator.pushNamed(context, '/about');
          },
          child: Text('Go to About'),
        ),
      ),
    );
  }
}

class AboutScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('About')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            Navigator.pop(context);
          },
          child: Text('Back to Home'),
        ),
      ),
    );
  }
}

Important Notes

Always use unique names for each route to avoid confusion.

You can pass data between screens using arguments with named routes.

Use Navigator.pop(context) to go back to the previous screen.

Summary

Named routes give each screen a simple name for easy navigation.

Define routes in MaterialApp with a map of names to screen widgets.

Use Navigator.pushNamed() to move to a screen and Navigator.pop() to go back.

Practice

1. What is the main purpose of using named routes in a Flutter app?

easy

A. To handle user input events

B. To style the app's theme

C. To manage app state globally

D. To give each screen a simple name for easy navigation

Solution

1. Step 1: Understand named routes concept

   Named routes assign simple string names to screens for easier navigation instead of using widget instances directly.

2. Step 2: Identify the main purpose

   This helps developers navigate between screens by referring to route names, making code cleaner and navigation simpler.

3. Final Answer:

   To give each screen a simple name for easy navigation -> Option D

4. Quick Check:

   Named routes = simple screen names for navigation [OK]

Hint: Named routes are simple screen names for navigation [OK]

Common Mistakes:

• Confusing named routes with app theming
• Thinking named routes manage app state
• Mixing named routes with event handling

2. Which of the following is the correct way to define named routes in a Flutter MaterialApp?

easy

A. MaterialApp(routeNames: {'/home': HomeScreen()})

B. MaterialApp(routes: {'/home': (context) => HomeScreen()})

C. MaterialApp(navigation: {'/home': HomeScreen()})

D. MaterialApp(namedRoutes: {'/home': () => HomeScreen()})

Solution

1. Step 1: Recall MaterialApp named routes syntax

   Named routes are defined using the 'routes' property with a map of route names to builder functions.

2. Step 2: Check each option

   MaterialApp(routes: {'/home': (context) => HomeScreen()}) correctly uses 'routes' with a map where the value is a function returning the widget. Other options use incorrect property names or values.

3. Final Answer:

   MaterialApp(routes: {'/home': (context) => HomeScreen()}) -> Option B

4. Quick Check:

   Use 'routes' with map of name to builder function [OK]

Hint: Use 'routes' property with map of names to builder functions [OK]

Common Mistakes:

• Using wrong property names like routeNames or navigation
• Assigning widget instance instead of builder function
• Missing context parameter in builder function

3. Given the following code snippet, what screen will be shown when Navigator.pushNamed(context, '/profile') is called?

MaterialApp(
  routes: {
    '/': (context) => HomeScreen(),
    '/profile': (context) => ProfileScreen(),
    '/settings': (context) => SettingsScreen(),
  },
)

medium

A. ProfileScreen

B. Error: Route not found

C. SettingsScreen

D. HomeScreen

Solution

1. Step 1: Check the routes map for '/profile'

   The routes map defines '/profile' as a key with ProfileScreen() as its widget builder.

2. Step 2: Understand Navigator.pushNamed behavior

   Calling Navigator.pushNamed with '/profile' will navigate to the ProfileScreen widget.

3. Final Answer:

   ProfileScreen -> Option A

4. Quick Check:

   Navigator.pushNamed('/profile') shows ProfileScreen [OK]

Hint: Match route name to widget in routes map [OK]

Common Mistakes:

• Confusing route names or mistyping them
• Assuming default screen shows instead of named route
• Expecting error when route exists

4. What is wrong with this code snippet for navigating to a named route?

Navigator.pushNamed('/settings');

medium

A. Navigator.pushNamed does not exist

B. Route name is incorrect

C. Missing BuildContext parameter

D. Should use Navigator.pop instead

Solution

1. Step 1: Check Navigator.pushNamed method signature

   Navigator.pushNamed requires a BuildContext as the first argument, then the route name as a string.

2. Step 2: Identify the error in the code

   The code calls Navigator.pushNamed with only the route name string, missing the required context parameter.

3. Final Answer:

   Missing BuildContext parameter -> Option C

4. Quick Check:

   Navigator.pushNamed needs context first [OK]

Hint: Navigator.pushNamed requires context and route name [OK]

Common Mistakes:

• Omitting the BuildContext argument
• Passing route name as first argument without context
• Confusing pushNamed with pop

5. You want to navigate from HomeScreen to DetailsScreen using named routes and pass an ID parameter. Which approach correctly passes the argument using Navigator.pushNamed?

hard

A. Navigator.pushNamed(context, '/details', arguments: 42);

B. Navigator.pushNamed(context, '/details/42');

C. Navigator.pushNamed('/details', arguments: 42);

D. Navigator.pushNamed(context, '/details', params: 42);

Solution

1. Step 1: Recall how to pass arguments with named routes

   Navigator.pushNamed accepts an optional 'arguments' parameter to pass data to the new screen.

2. Step 2: Analyze each option

   Navigator.pushNamed(context, '/details', arguments: 42); correctly passes context, route name, and arguments. Navigator.pushNamed(context, '/details/42'); tries to encode ID in route string (not standard). Navigator.pushNamed('/details', arguments: 42); misses context. Navigator.pushNamed(context, '/details', params: 42); uses wrong parameter name 'params'.

3. Final Answer:

   Navigator.pushNamed(context, '/details', arguments: 42); -> Option A

4. Quick Check:

   Use 'arguments' parameter to pass data [OK]

Hint: Pass data with 'arguments' parameter in pushNamed [OK]

Common Mistakes:

• Omitting context parameter
• Passing data in route string instead of arguments
• Using wrong parameter name like 'params'