Skip to main content

Installation

npm install react-amnesia

Peer dependencies​

  • react ^18.0.0 || ^19.0.0
  • react-dom ^18.0.0 || ^19.0.0
  • react-mnemonic >=1.5.0 — optional, only required if you import from react-amnesia/mnemonic
# Required:
npm install react react-dom

# Optional (for the persistence-aware bridge):
npm install react-mnemonic

Entry points​

Import pathUse when
react-amnesiaTop-level entry point. Re-exports the core surface. Drop-in default.
react-amnesia/corePure undo/redo runtime. No react-mnemonic dependency.
react-amnesia/mnemonicusePersistedUndoableState for undoable state that survives reloads.
react-amnesia/nativeNative editable detection + browser undo/redo dispatch helpers.

TypeScript​

react-amnesia ships its own .d.ts files. No additional @types/* package needed.

Next​

  • Quick Start — five-line hello world plus the most common patterns
  • AI Docs — canonical invariants, decision matrix, recipes
  • API Reference — every exported symbol