slate-vue3 0.14.1 → 1.0.0

package/README.md

@@ -17,6 +17,12 @@
 </p>
 <br/>
 
+> [!IMPORTANT]
+> **🚧 Major Refactor Notice**
+>
+> This project has undergone a **large-scale refactor**. The core library and all surrounding ecosystem packages have been **fully replaced with implementations identical to the official Slate**.
+> If you are on an older version, please read the migration guide carefully — legacy APIs may no longer be compatible.
+
 ### Why use it?
 
 1. :sparkles: Highly customizable features, use slate core at the bottom level
@@ -30,17 +36,15 @@
 #### 1. Install slate-vue3
 
 ```sh
-npm install slate-vue3
+npm install slate-vue3 slate-history
 ```
 
 #### 2. Now, you can use it in vue-sfc :point_right: [**live demo**](https://guan-erjia.github.io/slate-vue3/examples/rich-text)
 
 ```vue
 <script setup lang="ts">
-import { Slate, Editable, } from "slate-vue3";
-import { createEditor } from "slate-vue3/core";
-import { withDOM } from "slate-vue3/dom";
-import { withHistory } from "slate-vue3/history";
+import { Slate, Editable, createReactiveEditor } from "slate-vue3";
+import { withHistory } from "slate-history";
 
 const initialValue = [
   {
@@ -48,7 +52,7 @@ const initialValue = [
     children: [{ text: "Let's start" }],
   },
 ];
-const editor = withHistory(withDOM(createEditor()));
+const editor = withHistory(createReactiveEditor());
 editor.children = initialValue;
 </script>
 
@@ -99,11 +103,8 @@ Due to the complexity of maintaining multiple packages and the lack of reusabili
 
 | **Package**                                              |                                                                       **Version** | **Description**                                  |
 | :------------------------------------------------------- | --------------------------------------------------------------------------------: | :----------------------------------------------- |
-| [`slate-vue3/core`](./packages/slate)                    | ![](https://img.shields.io/npm/v/slate.svg?maxAge=3600&label=&colorB=007ec6) | slate's core data model logic.                   |
-| [`slate-vue3/dom`](./packages/slate-dom)                     | ![](https://img.shields.io/npm/v/slate-dom.svg?maxAge=3600&label=&colorB=007ec6) | DOM implementation of slate                      |
-| [`slate-vue3/history`](./packages/slate-history)         | ![](https://img.shields.io/npm/v/slate-history.svg?maxAge=3600&label=&colorB=007ec6) | a plugin that adds undo/redo history to slate.   |
-| [`slate-vue3/hyperscript`](./packages/slate-hyperscript) | ![](https://img.shields.io/npm/v/slate-hyperscript.svg?maxAge=3600&label=&colorB=007ec6) | a hyperscript tool to write JSX slate documents! |
-| [`slate-vue3/yjs`](./packages/slate-yjs)                 | ![](https://img.shields.io/npm/v/slate-yjs.svg?maxAge=3600&label=&colorB=007ec6) | integration of `slate-yjs`                       |
+| [`slate-vue3/dom`](./packages/slate-dom)                 | ![](https://img.shields.io/npm/v/slate-dom.svg?maxAge=3600&label=&colorB=007ec6)  | DOM implementation of slate                      |
+| [`slate-vue3/yjs`](./packages/slate-yjs)                 | ![](https://img.shields.io/npm/v/slate-yjs.svg?maxAge=3600&label=&colorB=007ec6)  | integration of `slate-yjs`                       |
 
 <br />
 

package/dist/dom.js

@@ -1,2 +1,2 @@
-import { $ as getSlateFragmentAttribute, A as HAS_BEFORE_INPUT_SUPPORT, B as IS_SAFARI_LEGACY, C as MARK_PLACEHOLDER_SYMBOL, D as NODE_TO_PARENT, E as NODE_TO_KEY, F as IS_CHROME_LEGACY, G as containsShadowAware, H as IS_WEBKIT, I as IS_EDGE_LEGACY, J as getDefaultView, K as getActiveElement, L as IS_FIREFOX, M as IS_ANDROID_CHROME_LEGACY, N as IS_APPLE, O as Key, P as IS_CHROME, Q as getSelection, R as IS_FIREFOX_LEGACY, S as IS_READ_ONLY, T as NODE_TO_INDEX, U as IS_WECHATBROWSER, V as IS_UC_MOBILE, W as closestShadowAware, X as getEditableChildAndIndex, Y as getEditableChild, Z as getPlainText, _ as EDITOR_TO_USER_SELECTION, a as Hotkeys, at as isDOMNode, b as IS_COMPOSING, c as withDOM, ct as isPlainTextOnlyPaste, d as getChunkTreeForNode, et as hasShadowRoot, f as DOMEditor, g as EDITOR_TO_USER_MARKS, h as EDITOR_TO_ON_CHANGE, i as splitDecorationsByChild, it as isDOMElement, j as IS_ANDROID, k as CAN_USE_DOM, l as reconcileChildren, lt as isTrackedMutation, m as EDITOR_TO_KEY_TO_ELEMENT, n as isTextDecorationsEqual, nt as isBefore, o as applyStringDiff, ot as isDOMSelection, p as EDITOR_TO_ELEMENT, q as getClipboardData, r as shallowCompare, rt as isDOMComment, s as normalizeStringDiff, st as isDOMText, t as isElementDecorationsEqual, tt as isAfter, u as KEY_TO_CHUNK_TREE, ut as normalizeDOMPoint, v as EDITOR_TO_WINDOW, w as NODE_TO_ELEMENT, x as IS_FOCUSED, y as ELEMENT_TO_NODE, z as IS_IOS } from "./slate-dom-DiZJwf8_.js";
-export { CAN_USE_DOM, DOMEditor, EDITOR_TO_ELEMENT, EDITOR_TO_KEY_TO_ELEMENT, EDITOR_TO_ON_CHANGE, EDITOR_TO_USER_MARKS, EDITOR_TO_USER_SELECTION, EDITOR_TO_WINDOW, ELEMENT_TO_NODE, HAS_BEFORE_INPUT_SUPPORT, Hotkeys, IS_ANDROID, IS_ANDROID_CHROME_LEGACY, IS_APPLE, IS_CHROME, IS_CHROME_LEGACY, IS_COMPOSING, IS_EDGE_LEGACY, IS_FIREFOX, IS_FIREFOX_LEGACY, IS_FOCUSED, IS_IOS, IS_READ_ONLY, IS_SAFARI_LEGACY, IS_UC_MOBILE, IS_WEBKIT, IS_WECHATBROWSER, KEY_TO_CHUNK_TREE, Key, MARK_PLACEHOLDER_SYMBOL, NODE_TO_ELEMENT, NODE_TO_INDEX, NODE_TO_KEY, NODE_TO_PARENT, applyStringDiff, closestShadowAware, containsShadowAware, getActiveElement, getChunkTreeForNode, getClipboardData, getDefaultView, getEditableChild, getEditableChildAndIndex, getPlainText, getSelection, getSlateFragmentAttribute, hasShadowRoot, isAfter, isBefore, isDOMComment, isDOMElement, isDOMNode, isDOMSelection, isDOMText, isElementDecorationsEqual, isPlainTextOnlyPaste, isTextDecorationsEqual, isTrackedMutation, normalizeDOMPoint, normalizeStringDiff, reconcileChildren, shallowCompare, splitDecorationsByChild, withDOM };
+import { $ as getSelection, A as CAN_USE_DOM, B as IS_IOS, C as MARK_PLACEHOLDER_SYMBOL, D as NODE_TO_PARENT, E as NODE_TO_KEY, F as IS_CHROME, G as closestShadowAware, H as IS_UC_MOBILE, I as IS_CHROME_LEGACY, J as getClipboardData, K as containsShadowAware, L as IS_EDGE_LEGACY, M as IS_ANDROID, N as IS_ANDROID_CHROME_LEGACY, O as PLACEHOLDER_SYMBOL, P as IS_APPLE, Q as getPlainText, R as IS_FIREFOX, S as IS_READ_ONLY, T as NODE_TO_INDEX, U as IS_WEBKIT, V as IS_SAFARI_LEGACY, W as IS_WECHATBROWSER, X as getEditableChild, Y as getDefaultView, Z as getEditableChildAndIndex, _ as EDITOR_TO_USER_SELECTION, a as Hotkeys, at as isDOMElement, b as IS_COMPOSING, c as withDOM, ct as isDOMText, dt as normalizeDOMPoint, et as getSlateFragmentAttribute, f as DOMEditor, g as EDITOR_TO_USER_MARKS, h as EDITOR_TO_ON_CHANGE, i as splitDecorationsByChild, it as isDOMComment, j as HAS_BEFORE_INPUT_SUPPORT, k as Key, lt as isPlainTextOnlyPaste, m as EDITOR_TO_KEY_TO_ELEMENT, n as isTextDecorationsEqual, nt as isAfter, o as applyStringDiff, ot as isDOMNode, p as EDITOR_TO_ELEMENT, q as getActiveElement, r as shallowCompare, rt as isBefore, s as normalizeStringDiff, st as isDOMSelection, t as isElementDecorationsEqual, tt as hasShadowRoot, ut as isTrackedMutation, v as EDITOR_TO_WINDOW, w as NODE_TO_ELEMENT, x as IS_FOCUSED, y as ELEMENT_TO_NODE, z as IS_FIREFOX_LEGACY } from "./slate-dom-CbCA1XcK.js";
+export { CAN_USE_DOM, DOMEditor, EDITOR_TO_ELEMENT, EDITOR_TO_KEY_TO_ELEMENT, EDITOR_TO_ON_CHANGE, EDITOR_TO_USER_MARKS, EDITOR_TO_USER_SELECTION, EDITOR_TO_WINDOW, ELEMENT_TO_NODE, HAS_BEFORE_INPUT_SUPPORT, Hotkeys, IS_ANDROID, IS_ANDROID_CHROME_LEGACY, IS_APPLE, IS_CHROME, IS_CHROME_LEGACY, IS_COMPOSING, IS_EDGE_LEGACY, IS_FIREFOX, IS_FIREFOX_LEGACY, IS_FOCUSED, IS_IOS, IS_READ_ONLY, IS_SAFARI_LEGACY, IS_UC_MOBILE, IS_WEBKIT, IS_WECHATBROWSER, Key, MARK_PLACEHOLDER_SYMBOL, NODE_TO_ELEMENT, NODE_TO_INDEX, NODE_TO_KEY, NODE_TO_PARENT, PLACEHOLDER_SYMBOL, applyStringDiff, closestShadowAware, containsShadowAware, getActiveElement, getClipboardData, getDefaultView, getEditableChild, getEditableChildAndIndex, getPlainText, getSelection, getSlateFragmentAttribute, hasShadowRoot, isAfter, isBefore, isDOMComment, isDOMElement, isDOMNode, isDOMSelection, isDOMText, isElementDecorationsEqual, isPlainTextOnlyPaste, isTextDecorationsEqual, isTrackedMutation, normalizeDOMPoint, normalizeStringDiff, shallowCompare, splitDecorationsByChild, withDOM };

package/dist/index.js

@@ -1,3 +1,3 @@
-import { C as SLATE_USE_COMPOSING, D as SLATE_USE_READ_ONLY, E as SLATE_USE_FOCUSED, O as SLATE_USE_SELECTION, S as isEventHandled, T as SLATE_USE_ELEMENT, _ as DEFAULT_SCROLL_INTO_VIEW, a as Editable, b as isDOMEventHandled, c as useElement, d as useEditor, f as DEFAULT_CHUNK_RENDER, g as DEFAULT_PLACEHOLDER_RENDER, h as DEFAULT_LEAF_RENDER, i as useFocused, l as useElementIf, m as DEFAULT_ELEMENT_RENDER, n as useSelection, o as useComposing, p as DEFAULT_DECORATE_FN, r as useSelected, s as useReadOnly, t as useInheritRef, u as Slate, v as DEFAULT_TEXT_RENDER, w as SLATE_USE_EDITOR, x as isDOMEventTargetInput, y as handleNativeHistoryEvents } from "./slate-vue-BYA7rdsz.js";
-import { t as toRawWeakMap } from "./share-tools-Dwm5Cmep.js";
-export { DEFAULT_CHUNK_RENDER, DEFAULT_DECORATE_FN, DEFAULT_ELEMENT_RENDER, DEFAULT_LEAF_RENDER, DEFAULT_PLACEHOLDER_RENDER, DEFAULT_SCROLL_INTO_VIEW, DEFAULT_TEXT_RENDER, Editable, SLATE_USE_COMPOSING, SLATE_USE_EDITOR, SLATE_USE_ELEMENT, SLATE_USE_FOCUSED, SLATE_USE_READ_ONLY, SLATE_USE_SELECTION, Slate, handleNativeHistoryEvents, isDOMEventHandled, isDOMEventTargetInput, isEventHandled, toRawWeakMap, useComposing, useEditor, useElement, useElementIf, useFocused, useInheritRef, useReadOnly, useSelected, useSelection };
+import { d as reconcileChildren, l as KEY_TO_CHUNK_TREE, u as getChunkTreeForNode } from "./slate-dom-CbCA1XcK.js";
+import { C as isEventHandled, D as SLATE_USE_FOCUSED, E as SLATE_USE_ELEMENT, O as SLATE_USE_READ_ONLY, S as isDOMEventTargetInput, T as SLATE_USE_EDITOR, _ as DEFAULT_PLACEHOLDER_RENDER, a as useFocused, b as handleNativeHistoryEvents, c as useReadOnly, d as useEditor, f as Slate, g as DEFAULT_LEAF_RENDER, h as DEFAULT_ELEMENT_RENDER, i as useSelected, k as SLATE_USE_SELECTION, l as useElement, m as DEFAULT_DECORATE_FN, n as useInheritRef, o as Editable, p as DEFAULT_CHUNK_RENDER, r as useSelection, s as useComposing, t as createReactiveEditor, u as useElementIf, v as DEFAULT_SCROLL_INTO_VIEW, w as SLATE_USE_COMPOSING, x as isDOMEventHandled, y as DEFAULT_TEXT_RENDER } from "./slate-vue-C5Tp0KRv.js";
+export { DEFAULT_CHUNK_RENDER, DEFAULT_DECORATE_FN, DEFAULT_ELEMENT_RENDER, DEFAULT_LEAF_RENDER, DEFAULT_PLACEHOLDER_RENDER, DEFAULT_SCROLL_INTO_VIEW, DEFAULT_TEXT_RENDER, Editable, KEY_TO_CHUNK_TREE, SLATE_USE_COMPOSING, SLATE_USE_EDITOR, SLATE_USE_ELEMENT, SLATE_USE_FOCUSED, SLATE_USE_READ_ONLY, SLATE_USE_SELECTION, Slate, createReactiveEditor, getChunkTreeForNode, handleNativeHistoryEvents, isDOMEventHandled, isDOMEventTargetInput, isEventHandled, reconcileChildren, useComposing, useEditor, useElement, useElementIf, useFocused, useInheritRef, useReadOnly, useSelected, useSelection };

package/dist/slate-dom/custom-types.d.ts

@@ -1,7 +1,9 @@
-import { BaseRange, BaseText } from '../slate/index.ts';
-declare module '../slate/index.ts' {
+import { BaseRange, BaseText } from 'slate';
+declare module "slate" {
     interface CustomTypes {
         Text: BaseText & {
+            placeholder?: string;
+            onPlaceholderResize?: (height?: number) => void;
             [key: string]: unknown;
         };
         Range: BaseRange & {

package/dist/slate-dom/index.d.ts

@@ -7,5 +7,4 @@ export * from './utils/environment';
 export * from './utils/hotkeys';
 export * from './utils/key';
 export * from './utils/range-list';
-export * from './chunking';
 export * from './utils/weak-maps';

package/dist/slate-dom/plugin/dom-editor.d.ts

@@ -1,4 +1,4 @@
-import { Ancestor, BaseEditor, Node, Path, Point, Range } from '../../slate/index.ts';
+import { Ancestor, BaseEditor, Node, Path, Point, Range } from 'slate';
 import { Key } from '../utils/key';
 type DOMNode = globalThis.Node;
 type DOMRange = globalThis.Range;
@@ -48,7 +48,9 @@ export interface DOMEditorInterface {
     /**
      * Focus the editor.
      */
-    focus: (editor: DOMEditor) => void;
+    focus: (editor: DOMEditor, options?: {
+        retries: number;
+    }) => void;
     /**
      * Return the host window of the current editor.
      */

package/dist/slate-dom/plugin/with-dom.d.ts

@@ -1,4 +1,4 @@
-import { BaseEditor } from '../../slate/index.ts';
+import { BaseEditor } from 'slate';
 import { DOMEditor } from './dom-editor';
 /**
  * `withDOM` adds DOM specific behaviors to the editor.

package/dist/slate-dom/utils/diff-text.d.ts

@@ -1,4 +1,4 @@
-import { Path } from '../../slate/index.ts';
+import { Path } from 'slate';
 export type StringDiff = {
     start: number;
     end: number;

package/dist/slate-dom/utils/lines.d.ts

@@ -1,4 +1,4 @@
-import { Range } from '../../slate/index.ts';
+import { Range } from 'slate';
 import { DOMEditor } from '../plugin/dom-editor';
 /**
  * A helper utility that returns the end portion of a `Range`

package/dist/slate-dom/utils/range-list.d.ts

@@ -1,5 +1,5 @@
 import { DOMEditor } from '../plugin/dom-editor';
-import { Ancestor, DecoratedRange, Range } from '../../slate/index.ts';
+import { Ancestor, DecoratedRange, Range } from 'slate';
 export declare const shallowCompare: (obj1: {
     [key: string]: unknown;
 }, obj2: {

package/dist/slate-dom/utils/weak-maps.d.ts

@@ -1,6 +1,5 @@
-import { Ancestor, Editor, Node, Operation, Point, Range, RangeRef, Text } from '../../slate/index.ts';
+import { Ancestor, Editor, Node, Operation, Point, Range, RangeRef, Text } from 'slate';
 import { Key } from './key';
-import { toRawWeakMap } from '../../share-tools/index.ts';
 export type Action = {
     at?: Point | Range;
     run: () => void;
@@ -15,24 +14,25 @@ export declare const NODE_TO_PARENT: WeakMap<Node, Ancestor>;
  * Weak maps that allow us to go between Slate nodes and DOM nodes. These
  * are used to resolve DOM event-related logic into Slate actions.
  */
-export declare const EDITOR_TO_WINDOW: WeakMap<import('../../slate/index.ts').BaseEditor, Window>;
-export declare const EDITOR_TO_ELEMENT: WeakMap<import('../../slate/index.ts').BaseEditor, HTMLElement>;
+export declare const EDITOR_TO_WINDOW: WeakMap<import('slate').BaseEditor, Window>;
+export declare const EDITOR_TO_ELEMENT: WeakMap<import('slate').BaseEditor, HTMLElement>;
 export declare const ELEMENT_TO_NODE: WeakMap<HTMLElement, Node>;
 export declare const NODE_TO_ELEMENT: WeakMap<Node, HTMLElement>;
-export declare const NODE_TO_KEY: toRawWeakMap<Node, Key>;
-export declare const EDITOR_TO_KEY_TO_ELEMENT: WeakMap<import('../../slate/index.ts').BaseEditor, WeakMap<Key, HTMLElement>>;
+export declare const NODE_TO_KEY: WeakMap<Node, Key>;
+export declare const EDITOR_TO_KEY_TO_ELEMENT: WeakMap<import('slate').BaseEditor, WeakMap<Key, HTMLElement>>;
 /**
  * Weak maps for storing editor-related state.
  */
-export declare const IS_READ_ONLY: WeakMap<import('../../slate/index.ts').BaseEditor, boolean>;
-export declare const IS_FOCUSED: WeakMap<import('../../slate/index.ts').BaseEditor, boolean>;
-export declare const IS_COMPOSING: WeakMap<import('../../slate/index.ts').BaseEditor, boolean>;
-export declare const EDITOR_TO_USER_SELECTION: WeakMap<import('../../slate/index.ts').BaseEditor, RangeRef | null>;
+export declare const IS_READ_ONLY: WeakMap<import('slate').BaseEditor, boolean>;
+export declare const IS_FOCUSED: WeakMap<import('slate').BaseEditor, boolean>;
+export declare const IS_COMPOSING: WeakMap<import('slate').BaseEditor, boolean>;
+export declare const EDITOR_TO_USER_SELECTION: WeakMap<import('slate').BaseEditor, RangeRef | null>;
 /**
  * Weak map for associating the context `onChange` context with the plugin.
  */
-export declare const EDITOR_TO_ON_CHANGE: WeakMap<import('../../slate/index.ts').BaseEditor, (options?: {
+export declare const EDITOR_TO_ON_CHANGE: WeakMap<import('slate').BaseEditor, (options?: {
     operation?: Operation;
 }) => void>;
 export declare const EDITOR_TO_USER_MARKS: WeakMap<Editor, Partial<Text> | null>;
+export declare const PLACEHOLDER_SYMBOL: string;
 export declare const MARK_PLACEHOLDER_SYMBOL: string;