@lexion-rte/react 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @lexion-rte/react
 
+## 0.1.2
+
+### Patch Changes
+
+- Refresh package metadata links and expand package-level README documentation.
+- Updated dependencies
+  - @lexion-rte/core@0.1.2
+  - @lexion-rte/extensions@0.1.2
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -2,9 +2,16 @@
 
 React adapter for Lexion.
 
-## What It Is
+## Overview
 
-`@lexion-rte/react` exposes `LexionEditorView`, a React component that supports controlled and uncontrolled usage.
+`@lexion-rte/react` exports `LexionEditorView`, a component that wraps ProseMirror wiring for React.
+
+It supports:
+
+- controlled mode (`value`)
+- uncontrolled mode (`defaultValue`)
+- custom external editor instances
+- read-only mode
 
 ## Install
 
@@ -12,22 +19,64 @@ React adapter for Lexion.
 pnpm add @lexion-rte/react react react-dom
 ```
 
-## Usage
+## Component Props
+
+`LexionEditorViewProps`:
+
+- `editor?: LexionEditor`
+- `value?: JSONDocument`
+- `defaultValue?: JSONDocument`
+- `onChange?: (value, editor) => void`
+- `onReady?: (editor) => void`
+- `readOnly?: boolean`
+- `className?: string`
+- `style?: CSSProperties`
+
+## Uncontrolled Example
+
+```tsx
+import { LexionEditorView } from "@lexion-rte/react";
+
+export function EditorScreen() {
+  return <LexionEditorView defaultValue={initialDoc} />;
+}
+```
+
+## Controlled Example
 
 ```tsx
 import { useState } from "react";
 import type { JSONDocument } from "@lexion-rte/core";
 import { LexionEditorView } from "@lexion-rte/react";
 
-export function EditorScreen() {
-  const [value, setValue] = useState<JSONDocument | undefined>(undefined);
+export function ControlledEditor({ initial }: { initial: JSONDocument }) {
+  const [value, setValue] = useState(initial);
 
   return (
     <LexionEditorView
       value={value}
       onChange={(nextValue) => setValue(nextValue)}
+      readOnly={false}
     />
   );
 }
 ```
 
+## External Editor Instance Example
+
+```tsx
+import { useMemo } from "react";
+import { LexionEditor } from "@lexion-rte/core";
+import { starterKitExtension } from "@lexion-rte/extensions";
+import { LexionEditorView } from "@lexion-rte/react";
+
+export function SharedEditor() {
+  const editor = useMemo(() => new LexionEditor({ extensions: [starterKitExtension] }), []);
+  return <LexionEditorView editor={editor} />;
+}
+```
+
+## Notes
+
+- In controlled mode, pass updated `value` back on every `onChange` call.
+- The component renders the same footer message as other adapters.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexion-rte/react",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "React adapter for the Lexion editor platform.",
   "private": false,
   "type": "module",
@@ -35,8 +35,8 @@
   },
   "dependencies": {
     "prosemirror-view": "^1.37.2",
-    "@lexion-rte/core": "0.1.1",
-    "@lexion-rte/extensions": "0.1.1"
+    "@lexion-rte/core": "0.1.2",
+    "@lexion-rte/extensions": "0.1.2"
   },
   "peerDependencies": {
     "react": "^18.2.0 || ^19.0.0",