@apollohg/react-native-rich-text-editor 2.0.0

package/LICENSE

@@ -0,0 +1,160 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed by
+their Contribution(s) alone or by combination of their Contribution(s) with the
+Work to which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent
+licenses granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability to
+use the Work (including but not limited to damages for loss of goodwill, work
+stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the
+possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,259 @@
+# React Native Rich Text Editor [![NPM version](https://img.shields.io/npm/v/@apollohg/react-native-rich-text-editor.svg?style=flat)](https://www.npmjs.com/package/@apollohg/react-native-rich-text-editor)
+
+`@apollohg/react-native-rich-text-editor` is a native rich text editor for React Native. It combines a Rust document core with native iOS and Android editing, a React toolbar and theme API, a Fabric prose viewer, and Yjs collaboration.
+
+See the [documentation](https://github.com/apollohg/react-native-rich-text-editor/wiki) for guides and API references. The package is under active development; review the [changelog](./CHANGELOG.md) before upgrading between major versions.
+
+<img src="https://github.com/apollohg/react-native-rich-text-editor/wiki/images/github-banner.png" alt="Example editor on iOS" width="100%" />
+
+## Highlights
+
+- Native iOS and Android editing backed by a Rust document engine
+- HTML and ProseMirror JSON input and output
+- Configurable schemas, marks, blockquotes, lists, links, images, and mentions
+- Custom atom nodes rendered with your React components
+- Native toolbar, theming, selection, undo, and redo
+- `RichTextViewer`, an exact-size Fabric renderer for read-only content
+- Shared document handles for local editing and Yjs collaboration
+
+`NativeRichTextEditor` and `NativeProseViewer`, along with their associated types, remain available as deprecated aliases of `RichTextEditor` and `RichTextViewer`.
+
+## Requirements
+
+The package uses custom native code and Expo Modules. Use a development build or a bare React Native app with Expo Modules configured; it does not run in Expo Go.
+
+Requires Expo 52+, React Native 0.76+, React 18+, and `@expo/vector-icons` 14+. `RichTextViewer` requires the New Architecture. See the [Installation Guide](https://github.com/apollohg/react-native-rich-text-editor/wiki/Installation) for platform requirements.
+
+## Installation
+
+Install the package and its icon peer dependency:
+
+```sh
+npm install @apollohg/react-native-rich-text-editor
+npx expo install @expo/vector-icons
+```
+
+Add the config plugin to an Expo app:
+
+```ts
+export default {
+    expo: {
+        plugins: ['@apollohg/react-native-rich-text-editor'],
+    },
+};
+```
+
+Then regenerate and rebuild the native app:
+
+```sh
+npx expo prebuild
+npx expo run:ios       # or: npx expo run:android
+```
+
+See the [Installation Guide](https://github.com/apollohg/react-native-rich-text-editor/wiki/Installation) for bare React Native setup and migration from `@apollohg/react-native-prose-editor`.
+
+## Editor usage
+
+Every editor binds to a `NativeEditorDocumentHandle`. Create the handle once, initialize its content there, and destroy it when its owner unmounts.
+
+```tsx
+import React, { useEffect, useMemo } from 'react';
+import {
+    createNativeEditorDocumentHandle,
+    RichTextEditor,
+} from '@apollohg/react-native-rich-text-editor';
+
+export function EditorScreen() {
+    const documentHandle = useMemo(
+        () =>
+            createNativeEditorDocumentHandle({
+                initialization: {
+                    type: 'localHtml',
+                    html: '<p>Hello world</p>',
+                },
+            }),
+        []
+    );
+
+    useEffect(() => () => documentHandle.destroy(), [documentHandle]);
+
+    return (
+        <RichTextEditor
+            documentHandle={documentHandle}
+            placeholder='Start typing…'
+            onContentChange={(html) => console.log(html)}
+        />
+    );
+}
+```
+
+See [Getting Started](https://github.com/apollohg/react-native-rich-text-editor/wiki/Getting-Started) and the [RichTextEditor reference](https://github.com/apollohg/react-native-rich-text-editor/wiki/RichTextEditor-Reference) for the complete API.
+
+## Custom atom nodes
+
+Render interactive cards, embeds, and other custom blocks with your own React components. Define an atom with `defineAtomNode`, add it to your document schema, and pass it through the editor or viewer's `atoms` prop.
+
+See [Custom Atom Nodes](https://github.com/apollohg/react-native-rich-text-editor/wiki/Custom-Atom-Nodes) for a complete example and API details.
+
+## Rich text viewer
+
+`RichTextViewer` displays HTML or ProseMirror JSON without creating an editor session. Place it in a container with a finite width:
+
+```tsx
+import { RichTextViewer } from '@apollohg/react-native-rich-text-editor';
+
+<RichTextViewer contentHTML='<p>Read-only content</p>' />;
+```
+
+See the [Viewer Guide](https://github.com/apollohg/react-native-rich-text-editor/wiki/Viewer) for styling, images, interactions, and custom atoms.
+
+## Element styling and addons
+
+Version 2 uses a flat, typed stylesheet for both the editor and viewer:
+
+```tsx
+import { EditorStyleSheet, RichTextEditor } from '@apollohg/react-native-rich-text-editor';
+
+const theme = EditorStyleSheet.create({
+    content: { padding: 16, backgroundColor: '#ffffff' },
+    text: { fontSize: 16, color: '#202124' },
+    paragraph: { marginBottom: 12 },
+    link: { color: '#285dcc', textDecorationLine: 'underline' },
+    blockquote: {
+        backgroundColor: '#f3f5f8',
+        padding: 12,
+        borderWidth: 1,
+        borderColor: '#dce1e8',
+        borderLeftWidth: 4,
+        borderLeftColor: '#285dcc',
+        borderTopRightRadius: 8,
+    },
+    codeBlock: { backgroundColor: '#eff1f5', padding: 12, borderRadius: 8 },
+    image: { backgroundColor: '#eff1f5', borderRadius: 12, resizeMode: 'cover' },
+});
+
+<RichTextEditor documentHandle={documentHandle} theme={theme} />;
+```
+
+Each entry accepts a style object or nested, conditional style arrays. Later entries override earlier properties; explicit `undefined` removes an earlier property. Side and corner properties override shorthands. Supported fields are checked by TypeScript and validated before native updates. These are editor styles: layout fields such as `flex`, transforms, and positioning are not accepted.
+
+Text styling inherits from `text` and enclosing blocks. Backgrounds, spacing, borders, and corner radii belong to each element. Inline entries support typography and backgrounds; mentions also support borders. List containers, items, markers, and checkboxes have separate entries. `toolbar` retains its existing configuration.
+
+Android editing uses per-block text layout for physical margins, borders, and padding, including RTL content. Per-block justification is supported on Android API 26+; API 24/25 use normal alignment.
+
+Custom atom components mount inside Android's native scrolling content. Their measured height participates in document layout, and their controls receive normal React Native touch events.
+
+Addons are a readonly array. Conditional `false`, `null`, and `undefined` entries are allowed; duplicate capabilities are rejected:
+
+```tsx
+import { createMentionsAddon } from '@apollohg/react-native-rich-text-editor';
+import { createCodeHighlightingAddon } from '@react-native-rich-text-editor/code-highlighting';
+
+<RichTextEditor
+    documentHandle={documentHandle}
+    theme={theme}
+    addons={[
+        createMentionsAddon({ trigger: '@', suggestions }),
+        enableHighlighting && createCodeHighlightingAddon({ theme: 'base16-ocean.dark' }),
+    ]}
+/>;
+```
+
+Syntax highlighting requires the separately installed [code-highlighting package](./packages/code-highlighting), followed by a native rebuild. The base editor does not include syntect or its grammars. Set a code block's `attrs.language`, for example `{ type: 'codeBlock', attrs: { language: 'typescript' }, content: [...] }`. Missing or unsupported languages keep ordinary code styling. The code block theme controls the panel; the highlighting addon controls token colors and font traits. Mention-enabled editor handles still require `withMentionsSchema` when creating their schema.
+
+When migrating from version 1, replace `links` with `link`, heading maps with `h1`–`h6`, `spacingAfter` with `marginBottom`, and `contentInsets` with `content.padding*`. Flatten nested quote/code typography into their element entry, and move list appearance into the relevant container/item/marker entries. Addon objects become `[createMentionsAddon(options)]`. The new built-in schema declares code-block language metadata; coordinate schema changes across collaborating clients.
+
+## Collaboration
+
+`useYjsCollaboration` connects a room-backed document handle to a Yjs sync and awareness server. The editor and collaboration controller must share the same handle.
+
+```tsx
+import React, { useEffect, useMemo } from 'react';
+import {
+    createNativeEditorDocumentHandle,
+    RichTextEditor,
+    useYjsCollaboration,
+} from '@apollohg/react-native-rich-text-editor';
+
+export function CollaborativeEditor({ documentId }: { documentId: string }) {
+    const documentHandle = useMemo(
+        () =>
+            createNativeEditorDocumentHandle({
+                initialization: {
+                    type: 'room',
+                    documentId,
+                    lineageId: `my-app|${documentId}`,
+                },
+            }),
+        [documentId]
+    );
+
+    const collaboration = useYjsCollaboration({
+        documentId,
+        handle: documentHandle,
+        transport: {
+            url: `wss://example.com/collaboration?documentId=${encodeURIComponent(documentId)}`,
+            connect: true,
+        },
+        localAwareness: {
+            userId: 'user-1',
+            name: 'Ada',
+            color: '#0A84FF',
+        },
+    });
+
+    useEffect(() => () => documentHandle.destroy(), [documentHandle]);
+
+    return <RichTextEditor {...collaboration.editorBindings} />;
+}
+```
+
+See the [Collaboration Guide](https://github.com/apollohg/react-native-rich-text-editor/wiki/Collaboration) for server requirements, persistence, authentication, and recovery.
+
+## Comparison with other React Native editors
+
+Reviewed on 7 September 2026
+
+| Editor | Editing surface | Nested lists | Extensions / customization | Collaborative editing | Atoms / embeds | Document format |
+| --- | --- | --- | --- | --- | --- | --- |
+| **This library** | Native; Fabric via Expo Modules; Rust core | Yes; indent / outdent | Configurable schemas, custom atoms, mentions and highlighting addons | Yjs / Yrs sync and awareness integration | Custom block atoms rendered with React Native components; mentions and images | HTML, ProseMirror JSON |
+| [TenTap (`@10play/tentap-editor`)](https://10play.github.io/10tap-editor/docs/mainConcepts) | WebView; Tiptap / ProseMirror | Yes; lift / sink | Bridge extensions and custom Tiptap extensions | Pro example / custom integration | Images; custom Tiptap nodes and atoms in the WebView | HTML, ProseMirror JSON, text |
+| [Enriched HTML (`react-native-enriched-html`)](https://github.com/software-mansion/react-native-enriched-html) | Native; Fabric | No; single-level lists | Curated HTML tags, styling and mention configuration | Unsupported | Built-in mentions and images; custom atom types unsupported | HTML, text |
+| [Enriched Markdown (`react-native-enriched-markdown`)](https://github.com/software-mansion/enriched-markdown/blob/main/docs/INPUT.md) | Native; Fabric | Yes; bullet / numbered lists | Formatting API, styling and mention configuration | Unsupported | Mentions; custom atom types unsupported | Markdown |
+| [Pell (`react-native-pell-rich-editor`)](https://github.com/wxik/react-native-rich-editor) | WebView; HTML `contenteditable` | Browser indent / outdent | Custom toolbar actions; injected JS, DOM and HTML | Unsupported | Images, video and HTML insertion; typed atom API unsupported | HTML |
+| [Live Markdown (`@expensify/react-native-live-markdown`)](https://github.com/Expensify/react-native-live-markdown) | Native `TextInput` with live syntax styling | Unsupported | Custom parser worklets over supported formatting types | Unsupported | Mention text styling; custom atom API unsupported | Markdown source (ExpensiMark by default) |
+
+## Development
+
+Run `npm run lint:kotlin` to check Kotlin style or `npm run format:kotlin` to
+apply automatic fixes. Both commands use ktlint 1.8.0 with Android Studio style
+and four-space indentation. Java 17+ is required (`JAVA_HOME` or `java` on PATH).
+The first run downloads and verifies the CLI into `.tmp/ktlint`; subsequent runs
+use the cached copy. Generated bindings, build output, dependencies, and Expo's
+generated native projects are excluded. Additional ktlint options can be passed
+after `--`, for example `npm run lint:kotlin -- --reporter=plain-summary`.
+
+See the [example app](./example) to try the editor and viewer, and the [Development Workflow](https://github.com/apollohg/react-native-rich-text-editor/wiki/Development-Workflow) for local setup, native builds, and testing.
+
+## Documentation
+
+- [Documentation index](https://github.com/apollohg/react-native-rich-text-editor/wiki)
+- [Installation](https://github.com/apollohg/react-native-rich-text-editor/wiki/Installation)
+- [Getting started](https://github.com/apollohg/react-native-rich-text-editor/wiki/Getting-Started)
+- [Editor API reference](https://github.com/apollohg/react-native-rich-text-editor/wiki/RichTextEditor-Reference)
+- [Viewer API reference](https://github.com/apollohg/react-native-rich-text-editor/wiki/RichTextViewer-Reference)
+- [Custom atom nodes](https://github.com/apollohg/react-native-rich-text-editor/wiki/Custom-Atom-Nodes)
+- [Collaboration](https://github.com/apollohg/react-native-rich-text-editor/wiki/Collaboration)
+- [Toolbar setup](https://github.com/apollohg/react-native-rich-text-editor/wiki/Toolbar-Setup)
+- [Mentions](https://github.com/apollohg/react-native-rich-text-editor/wiki/Mentions)
+- [Styling](https://github.com/apollohg/react-native-rich-text-editor/wiki/Styling)
+- [Production limits and errors](https://github.com/apollohg/react-native-rich-text-editor/wiki/Production-Limits-and-Errors)
+- [Changelog](./CHANGELOG.md)
+
+## License
+
+[Apache-2.0](./LICENSE) for this project's own code. Dependencies retain their respective licenses.
+
+[Third-party notices](./THIRD_PARTY_NOTICES.md) cover the bundled Rust libraries, native dependencies, and copied icon assets; [Rust standard-library notices](./RUST-STANDARD-LIBRARY-NOTICES.html) accompany the prebuilt native libraries. The optional highlighting package ships its own notices for syntect, grammars, themes, and its other dependencies.
+
+When distributing an app, include the applicable notices with the app's open-source acknowledgements or other accompanying materials, including the MPL corresponding-source links. Retain notices for the actual React Native/Expo and native dependency versions resolved by your app as well. An npm package's notices are not automatically copied into the final app by Metro. Refresh notices when dependencies, bundled assets, or the Rust toolchain change.