@apollohg/react-native-prose-editor 0.1.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,143 @@
+# React Native Prose Editor
+
+`@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.
+
+This project is currently in alpha and the API, behavior, and packaging may still change.
+
+<p align="center">
+  <img src="./docs/images/example-1.PNG" alt="Example editor screen" width="45%" />
+  <img src="./docs/images/example-2.PNG" alt="Example editor theme screen" width="45%" />
+</p>
+
+This repository contains three main pieces:
+
+- the editor package itself under [`src`](./src), [`ios`](./ios), [`android`](./android), and [`rust`](./rust)
+- an Expo SDK 54 development app under [`example`](./example)
+- a runnable iOS XCTest harness for native regression coverage
+
+## Features
+
+The editor already supports:
+
+- HTML and ProseMirror JSON content input/output
+- configurable schemas
+- marks such as bold, italic, underline, and strike
+- bullet and ordered lists with indent/outdent behavior
+- hard breaks and horizontal rules
+- native @-mentions with themed suggestion UI in the toolbar area
+- native theming for text, lists, horizontal rules, mentions, and the toolbar
+- configurable toolbar items, including app-defined actions
+- auto-grow height behavior for parent-managed scroll containers
+- a Rust-backed undo/redo history model
+
+## Repository Layout
+
+- [`src`](./src): React Native component API, toolbar, schemas, and TypeScript types
+- [`ios`](./ios): iOS native view, toolbar accessory, rendering bridge, and generated Rust bindings
+- [`android`](./android): Android native view, rendering bridge, and Expo module wiring
+- [`Rust Editor Core`](./rust/editor-core): document model, transforms, schema system, selection, history, serialization, and tests
+- [`example`](./example): Expo 54 app for manual QA and development
+- [`docs`](./docs): project documentation
+
+## Installation
+
+This package currently requires Expo Modules. Use it in an Expo development build or in a bare React Native app that has Expo Modules configured.
+
+The minimum tested Expo version is SDK 54.
+
+Required peer dependencies:
+
+- `expo`
+- `expo-modules-core`
+- `react`
+- `react-native`
+- `@expo/vector-icons`
+
+Install the package:
+
+```sh
+npm install @apollohg/react-native-prose-editor
+```
+
+For local package development in this repo:
+
+```sh
+npm install
+npm --prefix example install
+npm run example:prebuild
+```
+
+For full setup details, including peer dependencies, example app setup, and iOS pods, see the [Installation Guide](./docs/guides/installation.md).
+
+## Basic Usage
+
+```tsx
+import React, { useRef } from 'react';
+import {
+  NativeRichTextEditor,
+  type NativeRichTextEditorRef,
+} from '@apollohg/react-native-prose-editor';
+
+export function EditorScreen() {
+  const editorRef = useRef<NativeRichTextEditorRef>(null);
+
+  return (
+    <NativeRichTextEditor
+      ref={editorRef}
+      initialContent="<p>Hello world</p>"
+      placeholder="Start typing..."
+      onContentChange={(html) => {
+        console.log(html);
+      }}
+    />
+  );
+}
+```
+
+## Customization
+
+The main extension points today are:
+
+- `schema`: provide a custom schema definition
+- `theme`: style text blocks, lists, horizontal rules, background, and toolbar chrome
+- `toolbarItems`: define the visible toolbar controls and order
+- `onToolbarAction`: handle app-defined toolbar buttons
+- `addons`: configure optional features like @-mentions
+- `heightBehavior`: switch between internal scrolling and auto-grow
+
+For setup and customization details, start with the [Documentation Index](./docs/README.md).
+
+## Development
+
+Common commands:
+
+```sh
+npm run typecheck
+npm run example:start
+npm run example:ios
+npm run example:android
+npm run build:rust
+```
+
+Tests:
+
+```sh
+npm test                                             # TypeScript unit tests
+cargo test --manifest-path rust/editor-core/Cargo.toml  # Rust core tests
+npm run android:test                                  # Android Robolectric tests
+```
+
+## Documentation
+
+- [Documentation Index](./docs/README.md): main documentation index
+- [Installation Guide](./docs/guides/installation.md): installation and local setup
+- [Getting Started](./docs/guides/getting-started.md): first setup and first editor
+- [Toolbar Setup](./docs/guides/toolbar-setup.md): toolbar setup patterns and examples
+- [Mentions Guide](./docs/guides/mentions.md): @-mentions addon setup and configuration
+- [Styling Guide](./docs/guides/styling.md): content, toolbar, and mention styling
+- [NativeRichTextEditor Reference](./docs/reference/native-rich-text-editor.md): component props and ref methods
+- [Design Decisions](./docs/explanations/design-decisions.md): rationale for key API and architecture decisions
+
+## Project Status
+
+The project is usable and already covers the core editing flows, but the API and documentation are still evolving as the package moves toward wider use.

package/android/build.gradle

@@ -0,0 +1,39 @@
+plugins {
+    id 'com.android.library'
+    id 'expo-module-gradle-plugin'
+}
+
+group = 'com.apollohg'
+version = '0.1.0'
+
+android {
+    namespace "com.apollohg.editor"
+    testOptions {
+        unitTests.includeAndroidResources = true
+    }
+    defaultConfig {
+        versionCode 1
+        versionName '0.1.0'
+    }
+
+    // Include prebuilt Rust .so files from the package's rust/android/ directory
+    sourceSets {
+        main {
+            jniLibs.srcDirs = [
+                "${project.projectDir}/../rust/android"
+            ]
+            // Include the generated Kotlin UniFFI bindings
+            java.srcDirs += [
+                "${project.projectDir}/../rust/bindings/kotlin"
+            ]
+        }
+    }
+}
+
+dependencies {
+    implementation "androidx.appcompat:appcompat:1.7.0"
+    implementation "net.java.dev.jna:jna:5.14.0@aar"
+
+    testImplementation "junit:junit:4.13.2"
+    testImplementation "org.robolectric:robolectric:4.14.1"
+}