Home
@apollohg/react-native-prose-editor is a native rich text editor for React Native with a Rust document core, native iOS and Android rendering, configurable schemas, and a React-facing toolbar and theme API.
Start here if you are new to the package:
| Page | Description |
|---|---|
| Installation | Peer dependencies, local repository setup, example app setup, and platform notes. |
| Getting Started | First local setup, first editor, controlled vs uncontrolled mode, and common setup patterns. |
| Toolbar Setup | Built-in toolbar setup, custom toolbar configuration, standalone toolbar wiring, and action buttons. |
| Styling | Content theming, toolbar theming, mention theming, default toolbar fallbacks, and styling examples. |
| Page | Description |
|---|---|
| Mentions | @-mention addon setup, suggestion configuration, query and selection callbacks, and mention styling. |
| Collaboration |
useYjsCollaboration() wiring, imperative controller API, encoded-state persistence, and remote awareness integration. |
| Page | Description |
|---|---|
| NativeRichTextEditor Reference | Component props, callback signatures, and ref methods. |
| NativeProseViewer Reference | Read-only document renderer props, mention press events, and sizing behavior. |
| EditorToolbar Reference | Toolbar items, built-in defaults, icon types, and command values. |
| EditorTheme Reference | Theme shape, token types, editor surface styling, and toolbar defaults. |
| Editor State Reference | Selection, active state, history state, editor updates, render elements, and list context. |
| Schema Reference | Schema definition types and built-in schema presets. |
| Page | Description |
|---|---|
| Architecture | How the React Native layer, native views, render bridges, and Rust core fit together. |
| Design Decisions | Why the package uses typed themes, typed toolbar icons, Rust semantics, and different toolbar implementations by platform. |
| Page | Description |
|---|---|
| Development Workflow | Day-to-day commands, rebuild workflow, test entry points, and when to rebuild native artifacts. |