Installation

Package manager

Install the npm package:

npm install react-mnemonic@beta

The current 1.0.0 release line is being published to the npm beta dist-tag until final release hardening is complete.

Peer dependencies

React 18 or later is required. CI verifies packaged-consumer installs against React 18 and React 19.

{
    "peerDependencies": {
        "react": ">=18",
        "react-dom": ">=18"
    }
}

What's included

The package ships:

Format	File	Usage
ESM	dist/index.js	Modern bundlers (Vite, esbuild, webpack 5+)
CJS	dist/index.cjs	Node.js / legacy bundlers
Types	dist/index.d.ts	TypeScript declarations

The library is tree-shakeable, has zero runtime dependencies, and is SSR-safe by default. Without extra configuration, hooks render defaultValue on the server and then hydrate to persisted storage on the client.