@formulaxjs/tinymce 0.2.0 → 0.2.1

package/README.md

@@ -4,7 +4,7 @@ English | [简体中文](./README.zh-CN.md)
 
 TinyMCE integration adapter for FormulaX.
 
-`@formulaxjs/tinymce` registers FormulaX as a TinyMCE plugin and provides a modal-based formula editing experience for inserting and updating formulas inside TinyMCE content.
+`@formulaxjs/tinymce` registers FormulaX as a TinyMCE plugin and provides a modal-based formula editing experience for inserting and updating formulas inside TinyMCE content.
 
 > Status: experimental. Public APIs may change before the first stable release.
 
@@ -14,14 +14,14 @@ TinyMCE integration adapter for FormulaX.
 - FormulaX toolbar button and menu item support
 - `FormulaXOpen` TinyMCE command for programmatic opening
 - Insert and update formulas as non-editable inline nodes
-- Double-click, Enter, and Space editing interactions for existing formulas
-- TinyMCE compatibility layer for versions `>=5 <9`
-- LaTeX persistence through `data-formulax-latex`
-- Markup helpers for creating, parsing, serializing, finding, and replacing formula elements
-- Default read-only rendering through `@formulaxjs/renderer-kity`
-- Optional runtime preload before the first modal open
-
-## Compatibility
+- Double-click, Enter, and Space editing interactions for existing formulas
+- TinyMCE compatibility layer for versions `>=5 <9`
+- LaTeX persistence through `data-formulax-latex`
+- Markup helpers for creating, parsing, serializing, finding, and replacing formula elements
+- Default read-only rendering through `@formulaxjs/renderer-kity`
+- Optional runtime preload before the first modal open
+
+## Compatibility
 
 The package declares TinyMCE as an optional peer dependency:
 
@@ -40,8 +40,7 @@ The workspace demo can dynamically load TinyMCE 5, 6, 7, or 8 from CDN for compa
 When the package is published:
 
 ```bash
-pnpm add @formulaxjs/tinymce
-pnpm add tinymce
+npm install @formulaxjs/tinymce tinymce
 ```
 
 Inside the FormulaX workspace, use the workspace package directly:
@@ -62,14 +61,14 @@ import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
 registerFormulaXTinyMcePlugin(tinymce, {
   toolbarText: 'FormulaX',
   tooltip: 'Insert or edit formula',
-  modal: {
-    title: 'FormulaX Editor',
-  },
-  editor: {
-    height: '100%',
-    autofocus: true,
-    render: { fontsize: 40 },
-  },
+  modal: {
+    title: 'FormulaX Editor',
+  },
+  editor: {
+    height: '100%',
+    autofocus: true,
+    render: { fontsize: 40 },
+  },
 });
 
 await tinymce.init({
@@ -135,71 +134,71 @@ if (isFormulaElement(element)) {
 
 A generated formula node stores the source LaTeX in `data-formulax-latex` and is marked with `data-formulax="true"`:
 
-```html
-<span
-  class="formulax-math"
-  data-formulax="true"
-  data-formulax-latex="\\sqrt{x}"
-  data-latex="\\sqrt{x}"
-  contenteditable="false"
-  data-mce-contenteditable="false"
-  style="cursor: pointer"
-></span>
-```
-
-The exact generated markup is internal and may evolve. Consumers should rely on the exported helper functions where possible.
-
-## Custom renderer
-
-The adapter accepts a `renderer` option. By default it uses `createKityFormulaRenderer()` from `@formulaxjs/renderer-kity`.
-
-```ts
-import tinymce from 'tinymce';
-import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
-import { createKityFormulaRenderer } from '@formulaxjs/renderer-kity';
-
-registerFormulaXTinyMcePlugin(tinymce, {
-  renderer: createKityFormulaRenderer({
-    fontSize: 44,
-  }),
-});
-```
+```html
+<span
+  class="formulax-math"
+  data-formulax="true"
+  data-formulax-latex="\\sqrt{x}"
+  data-latex="\\sqrt{x}"
+  contenteditable="false"
+  data-mce-contenteditable="false"
+  style="cursor: pointer"
+></span>
+```
+
+The exact generated markup is internal and may evolve. Consumers should rely on the exported helper functions where possible.
+
+## Custom renderer
+
+The adapter accepts a `renderer` option. By default it uses `createKityFormulaRenderer()` from `@formulaxjs/renderer-kity`.
+
+```ts
+import tinymce from 'tinymce';
+import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
+import { createKityFormulaRenderer } from '@formulaxjs/renderer-kity';
+
+registerFormulaXTinyMcePlugin(tinymce, {
+  renderer: createKityFormulaRenderer({
+    fontSize: 44,
+  }),
+});
+```
 
 ## Options
 
 ```ts
-interface FormulaXTinyMceOptions {
-  pluginName?: string;
-  buttonName?: string;
-  menuItemName?: string;
-  toolbarText?: string;
-  tooltip?: string;
-  cursorStyle?: string;
-  formulaClassName?: string;
-  formulaAttributeName?: string;
-  renderer?: FormulaRenderer;
-  preload?: FormulaXEditorPreloadMode;
-  initialLatex?: string;
-  modal?: FormulaXModalOptions;
-  editor?: FormulaXEditorOptions;
-}
+interface FormulaXTinyMceOptions {
+  pluginName?: string;
+  buttonName?: string;
+  menuItemName?: string;
+  toolbarText?: string;
+  tooltip?: string;
+  cursorStyle?: string;
+  formulaClassName?: string;
+  formulaAttributeName?: string;
+  renderer?: FormulaRenderer;
+  preload?: FormulaXEditorPreloadMode;
+  initialLatex?: string;
+  modal?: FormulaXModalOptions;
+  editor?: FormulaXEditorOptions;
+}
 ```
 
 | Option | Default | Description |
 | --- | --- | --- |
 | `pluginName` | `formulax` | TinyMCE plugin name registered through `tinymce.PluginManager.add`. |
 | `buttonName` | `formulax` | Toolbar button name. |
-| `menuItemName` | `formulax` | Menu item name. |
-| `toolbarText` | `FormulaX` | Toolbar and menu item label. |
-| `tooltip` | `Insert formula` | Toolbar button tooltip. |
-| `cursorStyle` | `pointer` | Cursor style applied to generated formula nodes. |
-| `formulaClassName` | `formulax-math` | CSS class used by generated formula nodes. |
-| `formulaAttributeName` | `data-formulax-latex` | Attribute used to persist source LaTeX. |
-| `renderer` | `createKityFormulaRenderer()` | Renderer used when the plugin needs runtime formula HTML. |
-| `preload` | `idle` | Preloads the FormulaX runtime on browser idle, on host hover/focus, or never. |
-| `initialLatex` | empty string | Initial LaTeX when inserting a new formula. |
-| `modal` | see below | Modal labels, dimensions, and closing behavior. |
-| `editor` | see below | Embedded FormulaX editor options. |
+| `menuItemName` | `formulax` | Menu item name. |
+| `toolbarText` | `FormulaX` | Toolbar and menu item label. |
+| `tooltip` | `Insert formula` | Toolbar button tooltip. |
+| `cursorStyle` | `pointer` | Cursor style applied to generated formula nodes. |
+| `formulaClassName` | `formulax-math` | CSS class used by generated formula nodes. |
+| `formulaAttributeName` | `data-formulax-latex` | Attribute used to persist source LaTeX. |
+| `renderer` | `createKityFormulaRenderer()` | Renderer used when the plugin needs runtime formula HTML. |
+| `preload` | `idle` | Preloads the FormulaX runtime on browser idle, on host hover/focus, or never. |
+| `initialLatex` | empty string | Initial LaTeX when inserting a new formula. |
+| `modal` | see below | Modal labels, dimensions, and closing behavior. |
+| `editor` | see below | Embedded FormulaX editor options. |
 
 ### Modal options
 
@@ -217,10 +216,10 @@ interface FormulaXTinyMceOptions {
 
 | Option | Default | Description |
 | --- | --- | --- |
-| `height` | `100%` | Embedded editor height. |
-| `autofocus` | `true` | Whether the embedded editor should autofocus. |
-| `assets` | `{}` | Optional Kity runtime asset overrides. |
-| `render.fontsize` | `40` | Formula render font size. |
+| `height` | `100%` | Embedded editor height. |
+| `autofocus` | `true` | Whether the embedded editor should autofocus. |
+| `assets` | `{}` | Optional Kity runtime asset overrides. |
+| `render.fontsize` | `40` | Formula render font size. |
 
 ## Exported API
 

package/README.zh-CN.md

@@ -4,7 +4,7 @@
 
 FormulaX 的 TinyMCE 集成适配器。
 
-`@formulaxjs/tinymce` 会将 FormulaX 注册为 TinyMCE 插件，并提供基于弹窗的公式编辑体验，用于在 TinyMCE 内容中插入和更新公式。
+`@formulaxjs/tinymce` 会将 FormulaX 注册为 TinyMCE 插件，并提供基于弹窗的公式编辑体验，用于在 TinyMCE 内容中插入和更新公式。
 
 > 状态：实验阶段。在首个稳定版本发布前，公共 API 仍可能调整。
 
@@ -14,12 +14,12 @@ FormulaX 的 TinyMCE 集成适配器。
 - 支持 FormulaX 工具栏按钮和菜单项
 - 提供 `FormulaXOpen` TinyMCE 命令，便于代码中主动打开公式编辑器
 - 将公式作为不可直接编辑的 inline 节点插入和更新
-- 支持双击、Enter、Space 编辑已有公式
-- 面向 TinyMCE `>=5 <9` 的兼容层
-- 通过 `data-formulax-latex` 持久化 LaTeX 源内容
-- 提供创建、解析、序列化、查找和替换公式元素的 markup 工具函数
-- 默认通过 `@formulaxjs/renderer-kity` 完成只读渲染
-- 支持在首次打开弹窗前预加载 runtime
+- 支持双击、Enter、Space 编辑已有公式
+- 面向 TinyMCE `>=5 <9` 的兼容层
+- 通过 `data-formulax-latex` 持久化 LaTeX 源内容
+- 提供创建、解析、序列化、查找和替换公式元素的 markup 工具函数
+- 默认通过 `@formulaxjs/renderer-kity` 完成只读渲染
+- 支持在首次打开弹窗前预加载 runtime
 
 ## 兼容性
 
@@ -40,8 +40,7 @@ FormulaX 的 TinyMCE 集成适配器。
 包发布后可使用：
 
 ```bash
-pnpm add @formulaxjs/tinymce
-pnpm add tinymce
+npm install @formulaxjs/tinymce tinymce
 ```
 
 在 FormulaX 工作空间内，直接使用 workspace 包：
@@ -62,14 +61,14 @@ import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
 registerFormulaXTinyMcePlugin(tinymce, {
   toolbarText: 'FormulaX',
   tooltip: '插入或编辑公式',
-  modal: {
-    title: 'FormulaX 公式编辑器',
-  },
-  editor: {
-    height: '100%',
-    autofocus: true,
-    render: { fontsize: 40 },
-  },
+  modal: {
+    title: 'FormulaX 公式编辑器',
+  },
+  editor: {
+    height: '100%',
+    autofocus: true,
+    render: { fontsize: 40 },
+  },
 });
 
 await tinymce.init({
@@ -147,42 +146,42 @@ if (isFormulaElement(element)) {
 ></span>
 ```
 
-具体生成的 HTML 结构属于内部实现，后续可能演进。业务侧应优先依赖导出的工具函数。
-
-## 自定义 renderer
-
-该适配器支持 `renderer` 配置项。默认值是来自 `@formulaxjs/renderer-kity` 的 `createKityFormulaRenderer()`。
-
-```ts
-import tinymce from 'tinymce';
-import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
-import { createKityFormulaRenderer } from '@formulaxjs/renderer-kity';
-
-registerFormulaXTinyMcePlugin(tinymce, {
-  renderer: createKityFormulaRenderer({
-    fontSize: 44,
-  }),
-});
-```
+具体生成的 HTML 结构属于内部实现，后续可能演进。业务侧应优先依赖导出的工具函数。
+
+## 自定义 renderer
+
+该适配器支持 `renderer` 配置项。默认值是来自 `@formulaxjs/renderer-kity` 的 `createKityFormulaRenderer()`。
+
+```ts
+import tinymce from 'tinymce';
+import { registerFormulaXTinyMcePlugin } from '@formulaxjs/tinymce';
+import { createKityFormulaRenderer } from '@formulaxjs/renderer-kity';
+
+registerFormulaXTinyMcePlugin(tinymce, {
+  renderer: createKityFormulaRenderer({
+    fontSize: 44,
+  }),
+});
+```
 
 ## 配置项
 
 ```ts
-interface FormulaXTinyMceOptions {
-  pluginName?: string;
-  buttonName?: string;
-  menuItemName?: string;
-  toolbarText?: string;
-  tooltip?: string;
-  cursorStyle?: string;
-  formulaClassName?: string;
-  formulaAttributeName?: string;
-  renderer?: FormulaRenderer;
-  preload?: FormulaXEditorPreloadMode;
-  initialLatex?: string;
-  modal?: FormulaXModalOptions;
-  editor?: FormulaXEditorOptions;
-}
+interface FormulaXTinyMceOptions {
+  pluginName?: string;
+  buttonName?: string;
+  menuItemName?: string;
+  toolbarText?: string;
+  tooltip?: string;
+  cursorStyle?: string;
+  formulaClassName?: string;
+  formulaAttributeName?: string;
+  renderer?: FormulaRenderer;
+  preload?: FormulaXEditorPreloadMode;
+  initialLatex?: string;
+  modal?: FormulaXModalOptions;
+  editor?: FormulaXEditorOptions;
+}
 ```
 
 | 配置项 | 默认值 | 说明 |
@@ -192,14 +191,14 @@ interface FormulaXTinyMceOptions {
 | `menuItemName` | `formulax` | 菜单项名。 |
 | `toolbarText` | `FormulaX` | 工具栏按钮和菜单项显示文本。 |
 | `tooltip` | `Insert formula` | 工具栏按钮 tooltip。 |
-| `cursorStyle` | `pointer` | 应用于生成公式节点的鼠标光标样式。 |
-| `formulaClassName` | `formulax-math` | 生成的公式节点 CSS class。 |
-| `formulaAttributeName` | `data-formulax-latex` | 用于保存 LaTeX 源内容的属性。 |
-| `renderer` | `createKityFormulaRenderer()` | 插件在需要运行时公式 HTML 时使用的 renderer。 |
-| `preload` | `idle` | 控制在浏览器空闲时、宿主 hover/focus 时，或完全不预加载 FormulaX runtime。 |
-| `initialLatex` | 空字符串 | 插入新公式时的初始 LaTeX。 |
-| `modal` | 见下方 | 弹窗标题、按钮文本、尺寸和关闭行为。 |
-| `editor` | 见下方 | 内嵌 FormulaX 编辑器配置。 |
+| `cursorStyle` | `pointer` | 应用于生成公式节点的鼠标光标样式。 |
+| `formulaClassName` | `formulax-math` | 生成的公式节点 CSS class。 |
+| `formulaAttributeName` | `data-formulax-latex` | 用于保存 LaTeX 源内容的属性。 |
+| `renderer` | `createKityFormulaRenderer()` | 插件在需要运行时公式 HTML 时使用的 renderer。 |
+| `preload` | `idle` | 控制在浏览器空闲时、宿主 hover/focus 时，或完全不预加载 FormulaX runtime。 |
+| `initialLatex` | 空字符串 | 插入新公式时的初始 LaTeX。 |
+| `modal` | 见下方 | 弹窗标题、按钮文本、尺寸和关闭行为。 |
+| `editor` | 见下方 | 内嵌 FormulaX 编辑器配置。 |
 
 ### Modal 配置
 
@@ -217,10 +216,10 @@ interface FormulaXTinyMceOptions {
 
 | 配置项 | 默认值 | 说明 |
 | --- | --- | --- |
-| `height` | `100%` | 内嵌编辑器高度。 |
-| `autofocus` | `true` | 内嵌编辑器是否自动聚焦。 |
-| `assets` | `{}` | 可选的 Kity runtime 资源覆盖配置。 |
-| `render.fontsize` | `40` | 公式渲染字号。 |
+| `height` | `100%` | 内嵌编辑器高度。 |
+| `autofocus` | `true` | 内嵌编辑器是否自动聚焦。 |
+| `assets` | `{}` | 可选的 Kity runtime 资源覆盖配置。 |
+| `render.fontsize` | `40` | 公式渲染字号。 |
 
 ## 导出 API