mcpField
N
nextjs-zustand

nextjs-zustand

github.com/fusengineDevelopment3576 installsUpdated 1w ago
Repository

About nextjs-zustand

A skill for using Zustand v5 for client-side state in Next.js 16 App Router applications. It focuses on request-isolated Context-based stores, SSR hydration, middleware, and maintainable file organization.

Key features

  1. 01Shows Zustand v5 store creation syntax
  2. 02Uses Context-based stores for request isolation
  3. 03Covers middleware composition
  4. 04Handles persistence and SSR hydration
  5. 05Organizes stores by feature module

Use cases

  1. 01Managing shared state across Client Components
  2. 02Persisting UI state with hydration handling
  3. 03Structuring stores in an App Router project
  4. 04Avoiding unnecessary selector rerenders

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/fusengine/claude-plugins --skill nextjs-zustand

After installing, type/nextjs-zustandin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
auto-selectors.md
hydration.md
installation.md
middleware.md
migration-v5.md
nextjs-integration.md
reset-state.md
slices.md
store-patterns.md
subscribe-api.md
testing.md
typescript.md

Details

From the project README
Implements Zustand v5 client-side state management in Next.js 16 App Router: the v5 currying syntax (`create()((set) => ({...}))`), Context-based stores built with `createStore` from `zustand/vanilla` + `useRef` (required in App Router to avoid state leaking between requests — never a global store), and middleware composition (devtools → persist → immer, order-sensitive for TypeScript).

Covers skipHydration with the persist middleware plus manual rehydration in useEffect to avoid SSR mismatches, useShallow for array/object selectors, and SOLID file organization (store.ts, store-provider.tsx, use-store.ts). States explicitly that Zustand is Client-Components-only — never used in Server Components (fetch data directly there instead) and never used to persist auth tokens (use httpOnly cookies). Does not cover server state caching (see nextjs-tanstack-query for that).

Zustand for Next.js 16

Minimal, scalable state management with React 18+ useSyncExternalStore.

Agent Workflow (MANDATORY)

Before ANY implementation, spawn 3 agents in parallel, one Agent call each with a name:

  1. fuse-ai-pilot:explore-codebase - Analyze existing stores and state patterns
  2. fuse-ai-pilot:research-expert - Verify latest Zustand v5 docs via Context7/Exa
  3. mcp__context7__query-docs - Check middleware and TypeScript patterns

After implementation, run fuse-ai-pilot:sniper for validation.


Overview

When to Use
  • Managing client-side state in Next.js App Router applications
  • Need global state across Client Components only
  • Persisting state to localStorage/sessionStorage
  • Building UI state (modals, sidebars, theme, cart)
  • Replacing React Context for complex state
Why Zustand v5
FeatureBenefit
Minimal APISimple create() function, no boilerplate
React 18 nativeuseSyncExternalStore, no shims needed
TypeScript firstFull inference with currying pattern
Middleware stackdevtools, persist, immer composable
Bundle size~2KB gzipped, smallest state library
No providersDirect store access, no Context wrapper

Critical Rules

  1. Client Components ONLY - Never use Zustand in Server Components
  2. Context pattern for App Router - Avoid global stores (request isolation)
  3. useShallow for arrays/objects - Prevent unnecessary re-renders
  4. skipHydration with persist - Required for SSR compatibility
  5. Currying syntax v5 - create<State>()((set) => ({...}))
  6. SOLID paths - Stores in modules/[feature]/src/stores/

SOLID Architecture

Module Structure

Stores organized by feature module:

  • modules/cores/stores/ - Shared stores (theme, ui)
  • modules/auth/src/stores/ - Auth state
  • modules/cart/src/stores/ - Cart state
  • modules/[feature]/src/interfaces/ - Store types
File Organization
FilePurpose
store.tsStore creation with create() (max 40 lines, owner rule)
store.interface.tsTypeScript interfaces
store-provider.tsxContext provider (App Router)
use-store.tsCustom hook with selector

Key Concepts

Store Creation (v5 Syntax)

Double parentheses required for TypeScript inference. Currying pattern ensures full type safety.

Context-Based Stores

For Next.js App Router, wrap stores in Context to prevent request-sharing. Use createStore from zustand/vanilla with useRef for initialization.

Middleware Composition

Stack middlewares: devtools → persist → immer. Order matters for TypeScript types.

Hydration Handling

Use skipHydration: true with persist middleware. Manually rehydrate in useEffect to avoid SSR mismatches.


Reference Guide

NeedReference
Initial setupinstallation.md
Store patternsstore-patterns.md
SSR/Hydrationhydration.md
Middlewaremiddleware.md
Next.js App Routernextjs-integration.md
TypeScripttypescript.md
Slices patternslices.md
Auto selectorsauto-selectors.md
Reset statereset-state.md
Subscribe APIsubscribe-api.md
Testingtesting.md
Migration v4→v5migration-v5.md

Best Practices

  1. Selector pattern - Always use useStore((s) => s.field) for performance
  2. useShallow - Wrap array/object selectors to prevent re-renders
  3. Separate stores - One store per domain (auth, cart, ui, theme)
  4. Server data elsewhere - Use TanStack Query for server state
  5. DevTools in dev only - Wrap devtools in process.env check
  6. Partialize persist - Only persist necessary fields, never tokens

Forbidden Patterns

PatternReasonAlternative
Global stores in App RouterRequest sharing between usersContext-based stores
Zustand in Server ComponentsNo React hooks in RSCFetch data directly
Persisting auth tokensSecurity vulnerabilityhttpOnly cookies
Without useShallow on objectsExcessive re-rendersuseShallow(selector)
v4 syntaxTypeScript inference brokenv5 currying create<T>()()

Comments

Markdown supported