Navigation state persistence in React Native

Introduction

Navigation state persistence helps your app remember where you were last time you used it. This way, when you open the app again, it shows the same screen instead of starting over.

When you want users to continue where they left off after closing the app.

When your app has multiple screens and users switch between them often.

When you want to improve user experience by saving navigation history.

When your app needs to restore state after being killed by the system.

When you want to save deep links or special screen states for users.

Syntax

React Native

import React from 'react';
import AsyncStorage from '@react-native-async-storage/async-storage';
import { NavigationContainer } from '@react-navigation/native';

const PERSISTENCE_KEY = 'NAVIGATION_STATE';

export default function App() {
  const [isReady, setIsReady] = React.useState(false);
  const [initialState, setInitialState] = React.useState();

  React.useEffect(() => {
    const restoreState = async () => {
      try {
        const savedStateString = await AsyncStorage.getItem(PERSISTENCE_KEY);
        const state = savedStateString ? JSON.parse(savedStateString) : undefined;
        if (state) {
          setInitialState(state);
        }
      } finally {
        setIsReady(true);
      }
    };

    if (!isReady) {
      restoreState();
    }
  }, [isReady]);

  if (!isReady) {
    return null; // or a loading indicator
  }

  return (
    <NavigationContainer
      initialState={initialState}
      onStateChange={(state) =>
        AsyncStorage.setItem(PERSISTENCE_KEY, JSON.stringify(state))
      }
    >
      {/* Your navigators here */}
    </NavigationContainer>
  );
}

Use AsyncStorage to save and load navigation state asynchronously.

Wrap your app in NavigationContainer and provide initialState and onStateChange props.

Examples

This saves the navigation state as a string in storage.

React Native

const PERSISTENCE_KEY = 'NAV_STATE';

// Save state
AsyncStorage.setItem(PERSISTENCE_KEY, JSON.stringify(state));

This loads the saved state and parses it back to an object.

React Native

const savedStateString = await AsyncStorage.getItem(PERSISTENCE_KEY);
const state = savedStateString ? JSON.parse(savedStateString) : undefined;

This sets up the navigation container to restore and save state automatically.

React Native

<NavigationContainer
  initialState={initialState}
  onStateChange={state => AsyncStorage.setItem(PERSISTENCE_KEY, JSON.stringify(state))}
>

Sample App

This app has two screens: Home and Details. When you navigate between them, the app saves your place. If you close and reopen the app, it opens the screen you last visited.

React Native

import React from 'react';
import { View, Text, Button } from 'react-native';
import AsyncStorage from '@react-native-async-storage/async-storage';
import { NavigationContainer } from '@react-navigation/native';
import { createStackNavigator } from '@react-navigation/stack';

const Stack = createStackNavigator();
const PERSISTENCE_KEY = 'NAVIGATION_STATE';

function HomeScreen({ navigation }) {
  return (
    <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
      <Text>Home Screen</Text>
      <Button title="Go to Details" onPress={() => navigation.navigate('Details')} />
    </View>
  );
}

function DetailsScreen() {
  return (
    <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
      <Text>Details Screen</Text>
    </View>
  );
}

export default function App() {
  const [isReady, setIsReady] = React.useState(false);
  const [initialState, setInitialState] = React.useState();

  React.useEffect(() => {
    const restoreState = async () => {
      try {
        const savedStateString = await AsyncStorage.getItem(PERSISTENCE_KEY);
        const state = savedStateString ? JSON.parse(savedStateString) : undefined;
        if (state) {
          setInitialState(state);
        }
      } finally {
        setIsReady(true);
      }
    };

    if (!isReady) {
      restoreState();
    }
  }, [isReady]);

  if (!isReady) {
    return null;
  }

  return (
    <NavigationContainer
      initialState={initialState}
      onStateChange={(state) => AsyncStorage.setItem(PERSISTENCE_KEY, JSON.stringify(state))}
    >
      <Stack.Navigator>
        <Stack.Screen name="Home" component={HomeScreen} />
        <Stack.Screen name="Details" component={DetailsScreen} />
      </Stack.Navigator>
    </NavigationContainer>
  );
}

Important Notes

Make sure to install @react-native-async-storage/async-storage to use AsyncStorage.

Saving state on every navigation change may affect performance on very large apps; consider throttling if needed.

Test on both Android and iOS devices as storage behavior can differ slightly.

Summary

Navigation state persistence saves where the user is in the app.

Use AsyncStorage to save and restore navigation state.

Wrap your app in NavigationContainer with initialState and onStateChange props.

Practice

1. What is the main purpose of navigation state persistence in a React Native app?

easy

A. To change the app's theme based on user preference

B. To speed up the app's loading time by caching images

C. To save the user's current screen so they return to it after closing the app

D. To reset the app to the home screen every time it opens

Solution

1. Step 1: Understand navigation state persistence

   Navigation state persistence means saving where the user is in the app so they can continue from the same place later.

2. Step 2: Identify the correct purpose

   Only To save the user's current screen so they return to it after closing the app describes saving the current screen to restore it after app restart.

3. Final Answer:

   To save the user's current screen so they return to it after closing the app -> Option C

4. Quick Check:

   Navigation state persistence = save current screen [OK]

Hint: Remember: persistence means saving state for later use [OK]

Common Mistakes:

• Confusing navigation state with app theme or cache
• Thinking it resets app screens instead of saving them

2. Which of the following is the correct way to use NavigationContainer for state persistence?

easy

A.

B.

C.

D.

Solution

1. Step 1: Recall NavigationContainer props for persistence

   The correct props are initialState to set saved state and onStateChange to save new state.

2. Step 2: Match options with correct props

   Only uses initialState and onStateChange correctly.

3. Final Answer:

   <NavigationContainer initialState={savedState} onStateChange={saveState}> -> Option D

4. Quick Check:

   Use initialState and onStateChange props [OK]

Hint: Look for exact prop names: initialState and onStateChange [OK]

Common Mistakes:

• Using wrong prop names like state or onChange
• Swapping savedState and saveState variables

3. Given this code snippet, what will happen after the user navigates to 'Profile' and the app restarts?

const [initialState, setInitialState] = React.useState();
React.useEffect(() => {
  AsyncStorage.getItem('NAV_STATE').then(state => {
    if(state) setInitialState(JSON.parse(state));
  });
}, []);

 AsyncStorage.setItem('NAV_STATE', JSON.stringify(state))}
>
  {/* screens */}
;

medium

A. The app opens on the default initial screen ignoring saved state

B. The app opens on the 'Profile' screen automatically

C. The app crashes due to missing navigation state

D. The app opens on a blank screen

Solution

1. Step 1: Understand AsyncStorage usage

   The code loads saved navigation state from AsyncStorage and sets it as initialState.

2. Step 2: Effect of initialState on NavigationContainer

   Passing initialState restores the last screen, so the app opens on 'Profile' after restart.

3. Final Answer:

   The app opens on the 'Profile' screen automatically -> Option B

4. Quick Check:

   Saved state restores last screen [OK]

Hint: Saved state in initialState restores last screen [OK]

Common Mistakes:

• Assuming app ignores saved state and resets
• Thinking missing state causes crash

4. Identify the bug in this code that tries to persist navigation state:

const [navState, setNavState] = React.useState();

React.useEffect(() => {
  AsyncStorage.getItem('NAV_STATE').then(state => {
    setNavState(state);
  });
}, []);

 AsyncStorage.setItem('NAV_STATE', JSON.stringify(state))}
>
  {/* screens */}
;

medium

A. The saved state is not parsed from JSON before setting navState

B. The onStateChange callback should not stringify the state

C. initialState should be set to null instead of undefined

D. AsyncStorage.getItem should be called inside onStateChange

Solution

1. Step 1: Check AsyncStorage.getItem usage

   AsyncStorage.getItem returns a JSON string, so it must be parsed before use.

2. Step 2: Identify missing JSON.parse

   The code sets navState directly to the string, causing navigation to fail.

3. Final Answer:

   The saved state is not parsed from JSON before setting navState -> Option A

4. Quick Check:

   Parse JSON before setting state [OK]

Hint: Always parse JSON from AsyncStorage before using [OK]

Common Mistakes:

• Forgetting JSON.parse on saved state
• Misusing onStateChange callback

5. You want to persist navigation state but only save it after the user has navigated at least once. Which approach correctly implements this behavior?

hard

A. Use a ref to track if navigation happened, then save state in onStateChange only if true

B. Save state immediately on app start inside useEffect

C. Call AsyncStorage.clear() before saving state to avoid duplicates

D. Set initialState to null and never update it

Solution

1. Step 1: Understand conditional saving need

   We want to save navigation state only after user navigates once, so we track navigation occurrence.

2. Step 2: Use a ref to track navigation

   A ref can store a boolean flag that updates on first navigation, then onStateChange saves state only if true.

3. Step 3: Evaluate other options

   Save state immediately on app start inside useEffect saves immediately, ignoring condition; C clears storage unnecessarily; D disables persistence.

4. Final Answer:

   Use a ref to track if navigation happened, then save state in onStateChange only if true -> Option A

5. Quick Check:

   Track navigation with ref before saving state [OK]

Hint: Use a ref flag to save state only after first navigation [OK]

Common Mistakes:

• Saving state too early before navigation
• Clearing storage unnecessarily
• Ignoring initialState updates