math-rich-editor-pack 0.1.2 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
-# Math Rich Editor Pack
+# Math Rich Editor Pack
 
-Reusable React editor with rich-text + inline math insertion.
+Reusable React editor for rich text and math equations in the same flow.
 
 ## Install
 
@@ -8,63 +8,133 @@ Reusable React editor with rich-text + inline math insertion.
 npm install math-rich-editor-pack
 ```
 
-## Basic Usage
+```jsx
+import { MathRichEditor } from 'math-rich-editor-pack'
+import 'math-rich-editor-pack/style.css'
+```
+
+## Quick Start
 
 ```jsx
+import { useRef } from 'react'
 import { MathRichEditor } from 'math-rich-editor-pack'
 import 'math-rich-editor-pack/style.css'
 
 export default function QuestionForm() {
+  const editorRef = useRef(null)
+
   return (
     <MathRichEditor
+      ref={editorRef}
+      placeholder="Write question text and equations..."
       onChange={({ html, json, text, latexList }) => {
-        // Save the formats you need
+        // Save any format you need
       }}
     />
   )
 }
 ```
 
+## Built-In Features
+
+- Rich text editing (bold, italic, underline, headings, lists, undo/redo)
+- Equation insertion with MathLive keyboard and hardware keyboard
+- Inline math output with KaTeX rendering
+- Table support with clean UX:
+- Main toolbar has one `Table` button
+- Table controls appear only when cursor is inside a table
+- Advanced table actions are under `More`
+- Load content from HTML
+- Load content from DOCX (with equation conversion + warning reporting)
+
 ## Callback API
 
 - `onChange(payload)`
-  - `payload.html`
-  - `payload.json`
-  - `payload.text`
-  - `payload.latexList`
+- `payload.html`
+- `payload.json`
+- `payload.text`
+- `payload.latexList`
 - `onHtmlChange(html)`
 - `onJsonChange(json)`
 - `onTextChange(text)`
 - `onLatexChange(latexList)`
 - `onMathInsert(latex)`
+- `onLoadResult(result)`
+- `result.source`: `'html' | 'docx'`
+- `result.success`: `boolean`
+- `result.warnings`: `string[]`
+- `result.error`: `string | null`
+- `onDocxUnsupported(payload)`
+- `payload.items`: unsupported DOCX object summary (`chart`, `smartArt`, `shape`, `vmlShape`)
+- `payload.extractedMediaCount`: number
+- `payload.extractedMediaNames`: string[]
+
+## Ref Methods (Imperative API)
+
+Use `ref` on `MathRichEditor`:
+
+```jsx
+const editorRef = useRef(null)
+```
 
-## Main Props
+Available methods:
 
-- `initialContent` (HTML string or JSON doc)
-- `placeholder`
-- `toolbarOptions`
-  - default: `['bold','italic','underline','h1','h2','ul','ol','undo','redo','math']`
-- `mathShortcutEnabled` (default `true`)
-- `mathShortcutKey` (default `'m'`, used with Ctrl/Cmd)
+- `loadFromHtml(html: string): boolean`
+- `loadFromDocx(fileOrBuffer: File | Blob | ArrayBuffer): Promise<{ source, success, warnings, error, html, unsupported }>`
+- `getContent(): { html, json, text, latexList } | null`
+
+Example:
+
+```jsx
+editorRef.current?.loadFromHtml('<p>Hello <strong>world</strong></p>')
+
+const file = input.files?.[0]
+if (file) {
+  const result = await editorRef.current?.loadFromDocx(file)
+  console.log(result)
+}
+
+const current = editorRef.current?.getContent()
+```
+
+## DOCX Support Notes
+
+- Fully supported: regular text, formatting, lists, tables, OMML equations.
+- Partially supported: charts, SmartArt, geometry/shapes.
+- For unsupported objects:
+- editor inserts readable fallback text markers (so users know content was present)
+- warnings are returned in `onLoadResult`
+- `onDocxUnsupported` returns structured unsupported details
+- media from `word/media` is extracted and attached as fallback preview when unsupported objects are detected
+
+## Props
+
+- `initialContent`: HTML string or Tiptap JSON doc
+- `placeholder`: editor placeholder text
+- `toolbarOptions`: custom visible tools
+- Default: `['bold', 'italic', 'underline', 'h1', 'h2', 'ul', 'ol', 'table', 'undo', 'redo', 'math']`
+- `mathShortcutEnabled`: enable `Ctrl/Cmd + key` shortcut for equation composer
+- `mathShortcutKey`: shortcut key, default `'m'`
 - `className`, `toolbarClassName`, `editorClassName`
 - `composerTitle`, `composerDescription`, `composerInsertLabel`, `composerCancelLabel`
 
-## Local Dev
+## Local Development
 
 ```bash
 npm install
 npm run dev
 ```
 
-## Build Library
+## Build
 
 ```bash
 npm run build
 ```
 
-## Pack Tarball (local test)
+## Publish Checklist
 
 ```bash
-npm run pack:local
-```
-
+npm run build
+npm pack
+npm publish --access public
+```

package/dist-lib/_commonjs-dynamic-modules-BpilXLfW.js

@@ -0,0 +1,6 @@
+function r(o) {
+  throw new Error('Could not dynamically require "' + o + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');
+}
+export {
+  r as c
+};

package/dist-lib/_commonjsHelpers-DaMA6jEr.js

@@ -0,0 +1,8 @@
+var o = typeof globalThis < "u" ? globalThis : typeof window < "u" ? window : typeof global < "u" ? global : typeof self < "u" ? self : {};
+function l(e) {
+  return e && e.__esModule && Object.prototype.hasOwnProperty.call(e, "default") ? e.default : e;
+}
+export {
+  o as c,
+  l as g
+};