Home

React Native Rich Text Editor

These pages describe 2.x. Follow Migration Guide for changes since 1.0.3 and upgrade steps. Features documented here are not all available in 1.0.3.

@apollohg/react-native-rich-text-editor is a native rich-text editor for React Native. It pairs native iOS and Android editing with a Rust document engine, HTML and ProseMirror JSON, configurable schemas, consumer-rendered custom atoms, themes, toolbars, a Fabric viewer, and Yjs collaboration.

Every editor uses a shared NativeEditorDocumentHandle. Create that handle once, choose its initial document and engine policy there, mount RichTextEditor with it, and destroy it when its owner unmounts.

Start here

1. Review the migration guide, then install the package and make a development build.
2. Mount a first editor with an HTML or JSON-initialized handle.
3. Choose a content and state path before connecting persistence or React state.
4. Style the editor and configure the toolbar.
5. Add links and images when your editor needs host-provided URL or picker UI.

Core tasks

I want to…	Read
Create an editor in an Expo or bare React Native app	Installation and Getting Started
Start from or persist HTML / ProseMirror JSON	Content and State
Control the editor from buttons outside it	Content and State and Toolbar Setup
Change typography, document spacing, or toolbar chrome	Styling
Add formatting controls or place a toolbar inline	Toolbar Setup
Prompt for a URL or pick, upload, and insert an image	Links and Images
Render an interactive application component as a document node	Custom Atom Nodes
Display and revise provisional text inside the editor	External Text Composition

Advanced integrations

• Addons
• Code Syntax Highlighting
• Mentions
• Collaboration
• External Text Composition
• Custom Atom Nodes
• Schema Customization
• Viewer
• Production Limits and Errors

API reference

• RichTextEditor Reference
• RichTextViewer Reference
• EditorToolbar Reference
• EditorTheme Reference
• Document API Reference
• Types and Events Reference

Project internals

• Architecture
• Design Decisions
• Development Workflow