Getting Started
Installation
Install Typix and its peer dependencies
Prerequisites
- Node.js 18 or later
- React 18 or 19
- A package manager: pnpm, npm, or yarn
Install the core package
pnpm add @typix-editor/react npm install @typix-editor/reactyarn add @typix-editor/react@typix-editor/react requires Lexical 0.39+ and React 18.2+ (or React 19) as peer dependencies.
Install extensions (optional)
Extensions are separate packages you add as needed. For example:
pnpm add @typix-editor/extension-link @typix-editor/extension-short-cutsnpm install @typix-editor/extension-link @typix-editor/extension-short-cutsyarn add @typix-editor/extension-link @typix-editor/extension-short-cutsSee the Extensions overview for the full catalog.
Verify installation
Create a minimal editor to confirm everything is working:
import { EditorRoot, EditorContent } from '@typix-editor/react';
export default function App() {
return (
<EditorRoot>
<EditorContent placeholder="Type something..." />
</EditorRoot>
);
}If you see an editable text area, you're ready to go. Next, follow the Quick Start guide.