slate-vue3 0.0.2 → 0.0.3

package/License.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Guan-Erjia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Guan-Erjia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,108 +1,108 @@
-[<img src="https://raw.githubusercontent.com/ianstormtaylor/slate/main/docs/images/banner.png" />](https://github.com/ianstormtaylor/slate/raw/main/docs/images/banner.png)
-
-<p align="center">
-  slate-<a style="color: #087ea4" href="https://react.dev/">react</a> library implemented with <a style="color: #42b883" href="https://vuejs.org/">vue</a>
-</p>
-<br/>
-
-# Why use it?
-
-1. Use vue internal response implementation to reduce the number of re-renderings
-2. You can easily use vue-devtools to debug in a vue project
-3. This library provides the same usage as slate-react
-
-# Demo
-
-Check out the [**live demo**](https://guan-erjia.github.io/slate-vue3/) of all of the examples
-
-# Hooks
-
-## [useComposing](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-composing.ts)
-
-```
-const useFocused: () => Ref<boolean, boolean>
-```
-
-Get the current composing state of the editor. It deals with compositionstart, compositionupdate, compositionend events.
-
-Composition events are triggered by typing (composing) with a language that uses a composition character (e.g. Chinese, Japanese, Korean, etc.) example.
-Some basic Git commands are:
-
-## [useFocused](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-focus.ts)
-
-```
-const useFocused: () => Ref<boolean, boolean>
-```
-
-Get the current focused state of the editor.
-
-## [useReadOnly](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-read-only.ts)
-
-```
-const useReadOnly: () => Ref<boolean, boolean>
-```
-
-Get the current readOnly state of the editor.
-
-## [useSelected](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-selected.ts)
-
-```
-const useSelected: () => ComputedRef<boolean>
-```
-
-Get the current selected state of an element.
-
-## [useEditor](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-editor.ts)
-
-```
-const useSlate: () => Editor;
-```
-
-Get the current editor object from the React context. Re-renders the context whenever changes occur in the editor.
-
-## [useSelection](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-selection.ts)
-
-```
-const useSelection: () => ComputedRef<boolean>
-```
-
-Get the current editor selection from the React context.
-
-# Packages
-
-**slate's codebase is monorepo managed with pnpm workspace**
-
-- [slate](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate)
-  slate core logic, update synchronously with slate
-- [slate-dom](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate-dom)
-  Implementation of slate on dom, update synchronously with slate-dom
-- [slate-vue](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate-vue)
-  Vue components for rendering slate editors
-- [un-proxy-weakmap](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/un-proxy-weakmap)
-  for special processing of proxy type data, obtain the raw pointer
-
-# compact files of slate
-
-**reactive implement**
-
-1. packages/slate/src/interfaces/text.ts 115:115
-2. packages/slate/src/create-editor.ts 94:94
-3. packages/slate/src/transforms-node/set-nodes.ts 18:18
-
-**remove immer**
-
-1. packages/slate/src/interfaces/node.ts 365:365
-2. packages/slate/src/interfaces/point.ts 103:103
-3. packages/slate/src/interfaces/range.ts 224:224
-4. packages/slate/src/interfaces/transforms/general.ts 322:333
-
-**rewrite implement for WeakMap**
-
-1. packages/un-proxy-weakmap/src/index.ts
-2. packages/slate-dom/src/utils/weak-maps.ts
-
-**import types from globalThis in slate-dom**
-1. packages/slate-dom/src/index.ts
-2. packages/slate-dom/src/plugin/dom-editor.ts
-3. packages/slate-dom/src/utils/dom.ts
-
+[<img src="https://raw.githubusercontent.com/ianstormtaylor/slate/main/docs/images/banner.png" />](https://github.com/ianstormtaylor/slate/raw/main/docs/images/banner.png)
+
+<p align="center">
+  slate-<a style="color: #087ea4" href="https://react.dev/">react</a> library implemented with <a style="color: #42b883" href="https://vuejs.org/">vue</a>
+</p>
+<br/>
+
+# Why use it?
+
+1. Use vue internal response implementation to reduce the number of re-renderings
+2. You can easily use vue-devtools to debug in a vue project
+3. This library provides the same usage as slate-react
+
+# Demo
+
+Check out the [**live demo**](https://guan-erjia.github.io/slate-vue3/) of all of the examples
+
+# Hooks
+
+## [useComposing](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-composing.ts)
+
+```
+const useFocused: () => Ref<boolean, boolean>
+```
+
+Get the current composing state of the editor. It deals with compositionstart, compositionupdate, compositionend events.
+
+Composition events are triggered by typing (composing) with a language that uses a composition character (e.g. Chinese, Japanese, Korean, etc.) example.
+Some basic Git commands are:
+
+## [useFocused](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-focus.ts)
+
+```
+const useFocused: () => Ref<boolean, boolean>
+```
+
+Get the current focused state of the editor.
+
+## [useReadOnly](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-read-only.ts)
+
+```
+const useReadOnly: () => Ref<boolean, boolean>
+```
+
+Get the current readOnly state of the editor.
+
+## [useSelected](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-selected.ts)
+
+```
+const useSelected: () => ComputedRef<boolean>
+```
+
+Get the current selected state of an element.
+
+## [useEditor](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-editor.ts)
+
+```
+const useSlate: () => Editor;
+```
+
+Get the current editor object from the React context. Re-renders the context whenever changes occur in the editor.
+
+## [useSelection](https://github.com/Guan-Erjia/slate-vue3/blob/master/packages/slate-vue/src/hooks/use-selection.ts)
+
+```
+const useSelection: () => ComputedRef<boolean>
+```
+
+Get the current editor selection from the React context.
+
+# Packages
+
+**slate's codebase is monorepo managed with pnpm workspace**
+
+- [slate](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate)
+  slate core logic, update synchronously with slate
+- [slate-dom](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate-dom)
+  Implementation of slate on dom, update synchronously with slate-dom
+- [slate-vue](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/slate-vue)
+  Vue components for rendering slate editors
+- [un-proxy-weakmap](https://github.com/Guan-Erjia/slate-vue3/tree/master/packages/un-proxy-weakmap)
+  for special processing of proxy type data, obtain the raw pointer
+
+# compact files of slate
+
+**reactive implement**
+
+1. packages/slate/src/interfaces/text.ts 115:115
+2. packages/slate/src/create-editor.ts 94:94
+3. packages/slate/src/transforms-node/set-nodes.ts 18:18
+
+**remove immer**
+
+1. packages/slate/src/interfaces/node.ts 365:365
+2. packages/slate/src/interfaces/point.ts 103:103
+3. packages/slate/src/interfaces/range.ts 224:224
+4. packages/slate/src/interfaces/transforms/general.ts 322:333
+
+**rewrite implement for WeakMap**
+
+1. packages/un-proxy-weakmap/src/index.ts
+2. packages/slate-dom/src/utils/weak-maps.ts
+
+**import types from globalThis in slate-dom**
+1. packages/slate-dom/src/index.ts
+2. packages/slate-dom/src/plugin/dom-editor.ts
+3. packages/slate-dom/src/utils/dom.ts
+

package/dist/index.d.ts

@@ -2509,13 +2509,17 @@ renderLeaf: (props: RenderLeafProps) => VNode;
 renderPlaceholder: (props: RenderPlaceholderProps) => JSX.Element;
 }, () => VNode<RendererNode, RendererElement, {
 [key: string]: any;
-}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "selectionchange" | "valuechange")[], "change" | "selectionchange" | "valuechange", PublicProps, Readonly<{
 editor: DOMEditor;
 decorate: (entry: NodeEntry) => DecoratedRange[];
 renderElement: (props: RenderElementProps) => VNode;
 renderLeaf: (props: RenderLeafProps) => VNode;
 renderPlaceholder: (props: RenderPlaceholderProps) => JSX.Element;
-}> & Readonly<{}>, {
+}> & Readonly<{
+onChange?: ((...args: any[]) => any) | undefined;
+onSelectionchange?: ((...args: any[]) => any) | undefined;
+onValuechange?: ((...args: any[]) => any) | undefined;
+}>, {
 decorate: Function;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 

package/dist/slate-vue3.js

@@ -9582,10 +9582,7 @@ const withDOM = (editor, clipboardFormatKey = "x-slate-fragment") => {
       case "remove_node":
       case "merge_node":
       case "move_node":
-      case "split_node":
-      case "insert_text":
-      case "remove_text":
-      case "set_selection": {
+      case "split_node": {
         IS_NODE_MAP_DIRTY.set(e2, true);
       }
     }
@@ -10016,6 +10013,7 @@ const isTextDecorationsEqual = (list, another) => {
 };
 const Slate = /* @__PURE__ */ defineComponent({
   name: "slate-editor",
+  emits: ["change", "selectionchange", "valuechange"],
   props: {
     editor: {
       type: Object,

package/package.json

@@ -1,77 +1,77 @@
-{
-  "name": "slate-vue3",
-  "version": "0.0.2",
-  "type": "module",
-  "workspaces": [
-    "packages/*"
-  ],
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/"
-  ],
-  "scripts": {
-    "dev": "vite",
-    "build": "vite build",
-    "preview": "vite preview",
-    "build-all": "vite build --mode=lib"
-  },
-  "dependencies": {
-    "direction": "^2.0.1",
-    "is-hotkey": "^0.2.0",
-    "lodash-es": "^4.17.21",
-    "scroll-into-view-if-needed": "^3.1.0",
-    "slate": "workspace:*",
-    "slate-dom": "workspace:*",
-    "slate-history": "^0.110.3",
-    "slate-hyperscript": "^0.100.0",
-    "slate-vue": "workspace:*",
-    "vue": "^3.5.13",
-    "vue-router": "^4.5.0"
-  },
-  "devDependencies": {
-    "@faker-js/faker": "^9.4.0",
-    "@types/is-hotkey": "^0.1.10",
-    "@types/is-url": "^1.2.32",
-    "@types/lodash-es": "^4.17.12",
-    "@types/prismjs": "^1.26.5",
-    "@vitejs/plugin-vue": "^5.2.1",
-    "@vitejs/plugin-vue-jsx": "^4.1.1",
-    "@vue/tsconfig": "^0.7.0",
-    "image-extensions": "^1.1.0",
-    "is-url": "^1.2.4",
-    "prismjs": "^1.29.0",
-    "typescript": "~5.7.2",
-    "vite": "^6.0.11",
-    "vite-plugin-dts": "^4.5.0",
-    "vue-tsc": "^2.2.0"
-  },
-  "keywords": [
-    "canvas",
-    "contenteditable",
-    "docs",
-    "document",
-    "edit",
-    "editor",
-    "editable",
-    "html",
-    "immutable",
-    "markdown",
-    "medium",
-    "paper",
-    "react",
-    "rich",
-    "richtext",
-    "richtext",
-    "slate",
-    "slate-vue3",
-    "text",
-    "wysiwyg",
-    "wysiwym"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Guan-Erjia/slate-vue3"
-  }
-}
+{
+  "name": "slate-vue3",
+  "version": "0.0.3",
+  "type": "module",
+  "workspaces": [
+    "packages/*"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "build-all": "vite build --mode=lib"
+  },
+  "dependencies": {
+    "direction": "^2.0.1",
+    "is-hotkey": "^0.2.0",
+    "lodash-es": "^4.17.21",
+    "scroll-into-view-if-needed": "^3.1.0",
+    "slate": "workspace:*",
+    "slate-dom": "workspace:*",
+    "slate-history": "^0.110.3",
+    "slate-hyperscript": "^0.100.0",
+    "slate-vue": "workspace:*",
+    "vue": "^3.5.13",
+    "vue-router": "^4.5.0"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^9.4.0",
+    "@types/is-hotkey": "^0.1.10",
+    "@types/is-url": "^1.2.32",
+    "@types/lodash-es": "^4.17.12",
+    "@types/prismjs": "^1.26.5",
+    "@vitejs/plugin-vue": "^5.2.1",
+    "@vitejs/plugin-vue-jsx": "^4.1.1",
+    "@vue/tsconfig": "^0.7.0",
+    "image-extensions": "^1.1.0",
+    "is-url": "^1.2.4",
+    "prismjs": "^1.29.0",
+    "typescript": "~5.7.2",
+    "vite": "^6.0.11",
+    "vite-plugin-dts": "^4.5.0",
+    "vue-tsc": "^2.2.0"
+  },
+  "keywords": [
+    "canvas",
+    "contenteditable",
+    "docs",
+    "document",
+    "edit",
+    "editor",
+    "editable",
+    "html",
+    "immutable",
+    "markdown",
+    "medium",
+    "paper",
+    "react",
+    "rich",
+    "richtext",
+    "richtext",
+    "slate",
+    "slate-vue3",
+    "text",
+    "wysiwyg",
+    "wysiwym"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Guan-Erjia/slate-vue3"
+  }
+}