Shared state across layouts in NextJS

Introduction

Shared state across layouts lets different pages or sections of your app use the same data or settings. This helps keep things consistent and saves you from repeating code.

You want a user login status to be available on all pages.

You need a theme (dark or light mode) to stay the same across different layouts.

You want to keep a shopping cart updated no matter which page the user visits.

You want to share language or localization settings across the whole app.

Syntax

NextJS

'use client';
import { createContext, useContext, useState } from 'react';

const SharedStateContext = createContext();

export function SharedStateProvider({ children }) {
  const [state, setState] = useState(false);

  return (
    <SharedStateContext.Provider value={{ state, setState }}>
      {children}
    </SharedStateContext.Provider>
  );
}

export function useSharedState() {
  return useContext(SharedStateContext);
}

This pattern uses React Context to share state.

Wrap your layouts or pages with SharedStateProvider to give them access.

Examples

Wrap your root layout with the provider to share state across all pages and layouts inside.

NextJS

import { SharedStateProvider } from './SharedStateContext';

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <SharedStateProvider>
          {children}
        </SharedStateProvider>
      </body>
    </html>
  );
}

Use the shared state inside any component or layout by calling the custom hook.

NextJS

'use client';
import { useSharedState } from './SharedStateContext';

export default function Header() {
  const { state, setState } = useSharedState();

  return (
    <header>
      <button onClick={() => setState(!state)}>
        Toggle: {state ? 'On' : 'Off'}
      </button>
    </header>
  );
}

Sample Program

This example shows how to share a dark mode setting across layouts and pages. The SharedStateProvider wraps the app. The Header toggles the mode. The Page shows the current mode and changes style accordingly.

NextJS

'use client';
import { createContext, useContext, useState } from 'react';

const SharedStateContext = createContext();

export function SharedStateProvider({ children }) {
  const [darkMode, setDarkMode] = useState(false);

  return (
    <SharedStateContext.Provider value={{ darkMode, setDarkMode }}>
      {children}
    </SharedStateContext.Provider>
  );
}

export function useSharedState() {
  return useContext(SharedStateContext);
}

// RootLayout.js
export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <SharedStateProvider>
          {children}
        </SharedStateProvider>
      </body>
    </html>
  );
}

// Header.js
'use client';
import { useSharedState } from './SharedStateContext';

export default function Header() {
  const { darkMode, setDarkMode } = useSharedState();

  return (
    <header style={{ padding: '1rem', backgroundColor: darkMode ? '#222' : '#eee', color: darkMode ? '#eee' : '#222' }}>
      <button onClick={() => setDarkMode(!darkMode)} aria-label="Toggle dark mode">
        {darkMode ? 'Switch to Light Mode' : 'Switch to Dark Mode'}
      </button>
    </header>
  );
}

// Page.js
'use client';
import Header from './Header';
import { useSharedState } from './SharedStateContext';

export default function Page() {
  const { darkMode } = useSharedState();

  return (
    <main style={{ padding: '1rem', backgroundColor: darkMode ? '#333' : '#fff', color: darkMode ? '#ddd' : '#000' }}>
      <Header />
      <p>The current mode is {darkMode ? 'Dark' : 'Light'}.</p>
    </main>
  );
}

Important Notes

Always wrap your app or layouts with the provider to share state properly.

Use React Context carefully; too much shared state can slow your app.

For bigger apps, consider state management libraries or server state solutions.

Summary

Shared state lets multiple layouts and pages use the same data easily.

React Context with a provider and custom hook is a simple way to share state in Next.js.

Wrap your root layout with the provider and use the custom hook inside components.

Practice

1. What is the main benefit of sharing state across layouts in Next.js?

easy

A. It allows multiple layouts and pages to access the same data easily.

B. It improves the styling of components automatically.

C. It speeds up the server response time by caching data.

D. It prevents users from navigating between pages.

Solution

1. Step 1: Understand the purpose of shared state

   Shared state means multiple parts of the app can use the same data without duplication.

2. Step 2: Identify the benefit in Next.js layouts

   Sharing state across layouts lets pages and layouts access common data easily, improving consistency.

3. Final Answer:

   It allows multiple layouts and pages to access the same data easily. -> Option A

4. Quick Check:

   Shared state = common data access [OK]

Hint: Shared state means one data source for many layouts [OK]

Common Mistakes:

• Confusing shared state with styling or caching
• Thinking shared state blocks navigation
• Assuming shared state only affects server speed

2. Which of the following is the correct way to provide shared state in Next.js layouts using React Context?

easy

A. Import state from a CSS file and use it in layouts.

B. Wrap the root layout with a Context Provider component.

C. Use getServerSideProps to pass state to layouts.

D. Add state variables directly inside each layout without a provider.

Solution

1. Step 1: Recall React Context usage

   React Context requires wrapping components with a Provider to share state.

2. Step 2: Apply to Next.js layouts

   Wrapping the root layout with the Provider shares state across all nested layouts and pages.

3. Final Answer:

   Wrap the root layout with a Context Provider component. -> Option B

4. Quick Check:

   Provider wraps root layout = shared state [OK]

Hint: Always wrap root layout with Provider for shared state [OK]

Common Mistakes:

• Trying to add state without a Provider
• Using server props instead of Context for shared state
• Confusing CSS imports with state management

3. Given this code snippet in a Next.js app, what will be the output when clicking the button in any nested layout?

const CountContext = React.createContext();

function CountProvider({ children }) {
  const [count, setCount] = React.useState(0);
  return (
    <CountContext.Provider value={{ count, setCount }}>
      {children}
    </CountContext.Provider>
  );
}

function Button() {
  const { count, setCount } = React.useContext(CountContext);
  return <button onClick={() => setCount(count + 1)}>Clicked {count} times</button>;
}

// Root layout wraps children with <CountProvider>

medium

A. Clicking the button increases the count visible in all layouts sharing the context.

B. Clicking the button only updates the count inside the Button component itself.

C. Clicking the button causes a runtime error because context is not provided.

D. Clicking the button resets the count to zero every time.

Solution

1. Step 1: Understand context sharing

   The CountProvider shares count state via context to all nested components.

2. Step 2: Analyze button behavior

   Clicking the button calls setCount to increase count, updating all components using the context.

3. Final Answer:

   Clicking the button increases the count visible in all layouts sharing the context. -> Option A

4. Quick Check:

   Context state update = shared count change [OK]

Hint: Context updates reflect everywhere wrapped by Provider [OK]

Common Mistakes:

• Thinking state updates are local to Button only
• Assuming missing Provider causes error here
• Believing count resets on each click

4. You have wrapped your root layout with a Context Provider, but nested layouts cannot access the shared state. What is the most likely cause?

medium

A. You placed the Provider inside a nested layout instead of the root layout.

B. You used React.useState instead of React.useContext in the root layout.

C. You forgot to use the custom hook or React.useContext inside nested layouts.

D. You imported the context from a CSS file instead of a JavaScript file.

Solution

1. Step 1: Check how nested layouts access context

   Nested layouts must use React.useContext or a custom hook to read shared state.

2. Step 2: Identify common mistake

   Forgetting to call useContext means no access to the shared data, even if Provider is correct.

3. Final Answer:

   You forgot to use the custom hook or React.useContext inside nested layouts. -> Option C

4. Quick Check:

   Missing useContext call = no access [OK]

Hint: Use useContext hook inside nested layouts to access shared state [OK]

Common Mistakes:

• Placing Provider too deep, not at root
• Confusing useState with useContext
• Importing context incorrectly from non-JS files

5. You want to share a user authentication state across multiple layouts in Next.js. Which approach correctly combines shared state with server-side data fetching to keep the user logged in?

hard

A. Use local component state in each layout to store user info fetched from the server on mount.

B. Store user data only in getServerSideProps and pass it as props to each layout without using Context.

C. Save user info in a CSS variable and read it in layouts for shared state.

D. Wrap the root layout with a Context Provider that holds user state, and update it client-side after fetching user info in a server action or API route.

Solution

1. Step 1: Understand combining server data with shared state

   User info fetched server-side should be stored in a shared client state for consistent access.

2. Step 2: Use Context Provider at root layout

   Wrapping root layout with a Provider holding user state allows all layouts to access and update it.

3. Step 3: Update state client-side after server fetch

   Fetching user info via server actions or API routes and updating context keeps user logged in across layouts.

4. Final Answer:

   Wrap the root layout with a Context Provider that holds user state, and update it client-side after fetching user info in a server action or API route. -> Option D

5. Quick Check:

   Context + server fetch = shared auth state [OK]

Hint: Use Context Provider plus server fetch to share auth state [OK]

Common Mistakes:

• Passing user data only via props without shared state
• Using local state per layout causing inconsistent user info
• Trying to store user info in CSS or non-JS files