@chaitrabhairappa/react-native-rich-text-editor 1.0.0 → 1.0.1

package/README.md

@@ -2,6 +2,17 @@
 
 A powerful native rich text editor for React Native with support for text formatting, lists, and more. Works on both iOS and Android.
 
+Unlike other rich text editor packages that rely on HTML and WebView, this library is built with **pure native components** — using native iOS and Android text editing APIs directly. This provides better performance, smoother animations, and a more seamless integration with your React Native app.
+
+> **Note:** This library requires React Native's **New Architecture** to be enabled. It will not work with the old architecture.
+
+## Demo
+
+<p align="center">
+  <img src="./assets/demo-1.jpeg" width="300" alt="Demo 1" />
+  <img src="./assets/demo-2.jpeg" width="300" alt="Demo 2" />
+</p>
+
 ## Features
 
 - Bold, Italic, Underline, Strikethrough
@@ -20,9 +31,9 @@ A powerful native rich text editor for React Native with support for text format
 ## Installation
 
 ```bash
-npm install react-native-richtext-editor
+npm install @chaitrabhairappa/react-native-rich-text-editor
 # or
-yarn add react-native-richtext-editor
+yarn add @chaitrabhairappa/react-native-rich-text-editor
 ```
 
 ### iOS
@@ -43,8 +54,8 @@ import { View } from 'react-native';
 import RichTextEditor, {
   RichTextEditorRef,
   Block,
-  ContentChangeEvent
-} from 'react-native-richtext-editor';
+  ContentChangeEvent,
+} from '@chaitrabhairappa/react-native-rich-text-editor';
 
 const App = () => {
   const editorRef = useRef<RichTextEditorRef>(null);
@@ -90,19 +101,19 @@ export default App;
 
 ## Props
 
-| Prop | Type | Default | Description |
-|------|------|---------|-------------|
-| `placeholder` | `string` | `""` | Placeholder text |
-| `initialContent` | `Block[]` | `[]` | Initial content blocks |
-| `readOnly` | `boolean` | `false` | Make editor read-only |
-| `maxHeight` | `number` | `undefined` | Maximum height before scrolling |
-| `showToolbar` | `boolean` | `true` | Show/hide floating toolbar |
-| `toolbarOptions` | `ToolbarOption[]` | All options | Customize toolbar buttons |
-| `variant` | `'outlined' \| 'flat'` | `'outlined'` | Editor style variant |
-| `onContentChange` | `(event: ContentChangeEvent) => void` | `undefined` | Called when content changes |
-| `onSelectionChange` | `(event: SelectionChangeEvent) => void` | `undefined` | Called when selection changes |
-| `onFocus` | `() => void` | `undefined` | Called when editor gains focus |
-| `onBlur` | `() => void` | `undefined` | Called when editor loses focus |
+| Prop                | Type                                    | Default      | Description                     |
+| ------------------- | --------------------------------------- | ------------ | ------------------------------- |
+| `placeholder`       | `string`                                | `""`         | Placeholder text                |
+| `initialContent`    | `Block[]`                               | `[]`         | Initial content blocks          |
+| `readOnly`          | `boolean`                               | `false`      | Make editor read-only           |
+| `maxHeight`         | `number`                                | `undefined`  | Maximum height before scrolling |
+| `showToolbar`       | `boolean`                               | `true`       | Show/hide floating toolbar      |
+| `toolbarOptions`    | `ToolbarOption[]`                       | All options  | Customize toolbar buttons       |
+| `variant`           | `'outlined' \| 'flat'`                  | `'outlined'` | Editor style variant            |
+| `onContentChange`   | `(event: ContentChangeEvent) => void`   | `undefined`  | Called when content changes     |
+| `onSelectionChange` | `(event: SelectionChangeEvent) => void` | `undefined`  | Called when selection changes   |
+| `onFocus`           | `() => void`                            | `undefined`  | Called when editor gains focus  |
+| `onBlur`            | `() => void`                            | `undefined`  | Called when editor loses focus  |
 
 ## Ref Methods
 
@@ -173,30 +184,39 @@ interface StyleRange {
 }
 
 type ToolbarOption =
-  | 'bold' | 'italic' | 'strikethrough' | 'underline' | 'code' | 'highlight'
-  | 'heading' | 'bullet' | 'numbered' | 'quote' | 'checklist'
-  | 'link' | 'undo' | 'redo' | 'clearFormatting'
-  | 'indent' | 'outdent'
-  | 'alignLeft' | 'alignCenter' | 'alignRight';
+  | 'bold'
+  | 'italic'
+  | 'strikethrough'
+  | 'underline'
+  | 'code'
+  | 'highlight'
+  | 'heading'
+  | 'bullet'
+  | 'numbered'
+  | 'quote'
+  | 'checklist'
+  | 'link'
+  | 'undo'
+  | 'redo'
+  | 'clearFormatting'
+  | 'indent'
+  | 'outdent'
+  | 'alignLeft'
+  | 'alignCenter'
+  | 'alignRight';
 ```
 
 ## Customizing Toolbar
 
 ```tsx
-import RichTextEditor, { ToolbarOption } from 'react-native-richtext-editor';
+import RichTextEditor, { ToolbarOption } from '@chaitrabhairappa/react-native-rich-text-editor';
 
-const toolbarOptions: ToolbarOption[] = [
-  'bold',
-  'italic',
-  'underline',
-  'bullet',
-  'numbered',
-];
+const toolbarOptions: ToolbarOption[] = ['bold', 'italic', 'underline', 'bullet', 'numbered'];
 
 <RichTextEditor
   toolbarOptions={toolbarOptions}
   // ...
-/>
+/>;
 ```
 
 ## Android Setup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaitrabhairappa/react-native-rich-text-editor",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A powerful native rich text editor for React Native with support for text formatting, lists, and more",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -24,7 +24,8 @@
     "typescript": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "prepare": "bob build",
-    "clean": "del-cli lib"
+    "clean": "del-cli lib",
+    "publish:patch": "npm version patch && npm publish"
   },
   "keywords": [
     "react-native",