editor-svg 1.0.0

package/docs/.vitepress/config.ts

@@ -0,0 +1,191 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  base: '/canvas-editor-docs/',
+  title: 'canvas-editor',
+  description: 'rich text editor by canvas/svg',
+  themeConfig: {
+    i18nRouting: false,
+    algolia: {
+      appId: 'RWSVW6F3S5',
+      apiKey: 'e462fffb4d2e9ab4a78c29e0b457ab33',
+      indexName: 'hufe'
+    },
+    logo: '/favicon.png',
+    nav: [
+      {
+        text: '指南',
+        link: '/guide/start',
+        activeMatch: '/guide/'
+      },
+      {
+        text: 'Demo',
+        link: 'https://hufe.club/canvas-editor'
+      },
+      {
+        text: '官方插件',
+        link: '/guide/plugin-internal.html'
+      },
+      {
+        text: '赞助',
+        link: 'https://hufe.club/donate.jpg'
+      }
+    ],
+    sidebar: [
+      {
+        text: '开始',
+        items: [
+          { text: '入门', link: '/guide/start' },
+          { text: '配置', link: '/guide/option' },
+          { text: '国际化', link: '/guide/i18n' },
+          { text: '数据结构', link: '/guide/schema' }
+        ]
+      },
+      {
+        text: '命令',
+        items: [
+          { text: '执行动作命令', link: '/guide/command-execute' },
+          { text: '获取数据命令', link: '/guide/command-get' }
+        ]
+      },
+      {
+        text: '监听',
+        items: [
+          { text: '事件监听(listener)', link: '/guide/listener' },
+          { text: '事件监听(eventBus)', link: '/guide/eventbus' }
+        ]
+      },
+      {
+        text: '快捷键',
+        items: [
+          { text: '内部快捷键', link: '/guide/shortcut-internal' },
+          { text: '自定义快捷键', link: '/guide/shortcut-custom' }
+        ]
+      },
+      {
+        text: '右键菜单',
+        items: [
+          { text: '内部右键菜单', link: '/guide/contextmenu-internal' },
+          { text: '自定义右键菜单', link: '/guide/contextmenu-custom' }
+        ]
+      },
+      {
+        text: '重写方法',
+        items: [{ text: '重写方法', link: '/guide/override' }]
+      },
+      {
+        text: 'API',
+        items: [
+          { text: '实例API', link: '/guide/api-instance' },
+          { text: '通用API', link: '/guide/api-common' }
+        ]
+      },
+      {
+        text: '插件',
+        items: [
+          { text: '自定义插件', link: '/guide/plugin-custom' },
+          { text: '官方插件', link: '/guide/plugin-internal' }
+        ]
+      }
+    ],
+    socialLinks: [
+      {
+        icon: 'github',
+        link: 'https://github.com/Hufe921/canvas-editor'
+      }
+    ],
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2021-present Hufe'
+    }
+  },
+  locales: {
+    root: {
+      label: '简体中文',
+      lang: 'zh-CN'
+    },
+    en: {
+      label: 'English',
+      lang: 'en',
+      link: '/en/',
+      themeConfig: {
+        nav: [
+          {
+            text: 'Guide',
+            link: '/en/guide/start',
+            activeMatch: '/en/guide/'
+          },
+          {
+            text: 'Demo',
+            link: 'https://hufe.club/canvas-editor'
+          },
+          {
+            text: 'Official plugin',
+            link: '/en/guide/plugin-internal.html'
+          },
+          {
+            text: 'Donate',
+            link: 'https://hufe.club/donate.jpg'
+          }
+        ],
+        sidebar: [
+          {
+            text: 'Start',
+            items: [
+              { text: 'start', link: '/en/guide/start' },
+              { text: 'option', link: '/en/guide/option' },
+              { text: 'i18n', link: '/en/guide/i18n' },
+              { text: 'schema', link: '/en/guide/schema' }
+            ]
+          },
+          {
+            text: 'Command',
+            items: [
+              { text: 'execute', link: '/en/guide/command-execute' },
+              { text: 'get', link: '/en/guide/command-get' }
+            ]
+          },
+          {
+            text: 'Listener',
+            items: [
+              { text: 'listener', link: '/en/guide/listener' },
+              { text: 'eventbus', link: '/en/guide/eventbus' }
+            ]
+          },
+          {
+            text: 'Shortcut',
+            items: [
+              { text: 'internal', link: '/en/guide/shortcut-internal' },
+              { text: 'custom', link: '/en/guide/shortcut-custom' }
+            ]
+          },
+          {
+            text: 'Contextmenu',
+            items: [
+              { text: 'internal', link: '/en/guide/contextmenu-internal' },
+              { text: 'custom', link: '/en/guide/contextmenu-custom' }
+            ]
+          },
+          {
+            text: 'Override',
+            items: [{ text: 'override', link: '/en/guide/override' }]
+          },
+          {
+            text: 'Api',
+            items: [
+              { text: 'instance', link: '/en/guide/api-instance' },
+              { text: 'common', link: '/en/guide/api-common' }
+            ]
+          },
+          {
+            text: 'Plugin',
+            items: [
+              { text: 'custom', link: '/en/guide/plugin-custom' },
+              { text: 'official', link: '/en/guide/plugin-internal' }
+            ]
+          }
+        ]
+      }
+    }
+  }
+})

package/docs/.vitepress/theme/components/DeepWikiBadge.vue

@@ -0,0 +1,21 @@
+<template>
+  <a href="https://deepwiki.com/Hufe921/canvas-editor" target="_blank" class="badge-link">
+    <img
+      src="https://img.shields.io/badge/Ask_DeepWiki-_.svg?style=flat&color=0094de&labelColor=000000&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGNsYXNzPSJzaXplLTQgdHJhbnNmb3JtIHRyYW5zaXRpb24tdHJhbnNmb3JtIGR1cmF0aW9uLTcwMCBncm91cC1ob3Zlcjpyb3RhdGUtMTgwIFsmYW1wO19wYXRoXTpzdHJva2UtMCIgdmlld0JveD0iMTEwIDExMCA0NjAgNTAwIj48cGF0aCBkPSJNNDE5IDMzMnExNi03IDMyIDBsMjUgMTUgMyAxIDMgMSAzLTEgMy0xIDUxLTI5cTYtMyA2LTExdi01OHEwLTgtNi0xMWwtNTEtMjlxLTYtMy0xMiAwbC01MSAyOXYxbC0yIDEtMiAydjFsLTEgMnYxbC0xIDN2MjlhMzIgMzIgMCAwIDEtNDggMjhsLTI1LTE1LTMtMS0zLTEtMyAxLTMgMS01MSAyOXEtNSAzLTYgMTF2NThxMSA4IDYgMTFsNTEgMjkgMyAxIDMgMSAzLTEgMy0xIDI1LTE1YTMyIDMyIDAgMCAxIDQ4IDI4djI5bDEgM3YxbDEgMnYxbDIgMiAyIDIgNTEgMjkgNiAyIDYtMiA1MS0yOXE2LTMgNi0xMXYtNThxMC04LTYtMTFsLTUxLTI5LTMtMS0zLTEtMyAxLTMgMS0yNSAxNWEzMiAzMiAwIDAgMS00OC0yOHExLTE4IDE2LTI4IiBzdHlsZT0iZmlsbDojMjFjMTlhIi8+PHBhdGggZD0ibTE0MSAzMTggNTEgMjkgNiAyIDYtMiA1MS0yOXYtMWwyLTEgMi0ydi0xbDEtMnYtMWwxLTN2LTI5YTMyIDMyIDAgMCAxIDQ4LTI4bDI1IDE1IDMgMSAzIDEgMy0xIDMtMSA1MS0yOXE2LTMgNi0xMXYtNThxMC04LTYtMTFsLTUxLTI5cS02LTMtMTIgMGwtNTEgMjktMiAyaC0xbC0xIDJ2MWwtMSAydjFsLTEgM3YyOWEzMiAzMiAwIDAgMS00OCAyOGwtMjUtMTUtMy0xLTMtMS0zIDEtMyAxLTUxIDI5cS02IDMtNiAxMXY1OHEwIDggNiAxMSIgc3R5bGU9ImZpbGw6IzM5NjljYSIvPjxwYXRoIGQ9Im0zOTcgNDg0LTUxLTI5LTMtMS0zLTEtMyAxLTMgMS0yNSAxNWEzMiAzMiAwIDAgMS00OC0yOHYtMjlsLTEtM3YtMWwtMS0ydi0xbC0yLTItMi0xdi0xbC01MS0yOXEtNi0zLTEyIDBsLTUxIDI5cS02IDMtNiAxMXY1OHEwIDggNiAxMWw1MSAyOSAzIDEgMyAxIDMtMSAzLTEgMjUtMTVhMzIgMzIgMCAwIDEgNDggMjh2MjlsMSAzdjFsMSAydjFsMiAyIDIgMiA1MSAyOSA2IDIgNi0yIDUxLTI5cTYtMyA2LTExdi01OHEwLTgtNi0xMSIgc3R5bGU9ImZpbGw6IzAyOTRkZSIvPjwvc3ZnPg==&logoColor=ffffff"
+      alt="DeepWiki"
+      class="badge-img"
+    />
+  </a>
+</template>
+
+<style scoped>
+.badge-link {
+  display: flex;
+  align-items: center;
+}
+.badge-img {
+  height: 18px;
+  vertical-align: middle;
+  transform: translateY(1px);
+}
+</style>

package/docs/.vitepress/theme/components/ZreadBadge.vue

@@ -0,0 +1,21 @@
+<template>
+  <a href="https://zread.ai/Hufe921/canvas-editor" target="_blank" class="badge-link">
+    <img
+      src="https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8+CjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8+CjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8+CjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff"
+      alt="zread"
+      class="badge-img"
+    />
+  </a>
+</template>
+
+<style scoped>
+.badge-link {
+  display: flex;
+  align-items: center;
+}
+.badge-img {
+  height: 18px;
+  vertical-align: middle;
+  transform: translateY(1px);
+}
+</style>

package/docs/.vitepress/theme/index.ts

@@ -0,0 +1,27 @@
+import DefaultTheme from 'vitepress/theme'
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import ZreadBadge from './components/ZreadBadge.vue'
+import DeepWikiBadge from './components/DeepWikiBadge.vue'
+
+export default {
+  extends: DefaultTheme,
+  Layout() {
+    return h(DefaultTheme.Layout, null, {
+      'nav-bar-content-after': () =>
+        h(
+          'div',
+          {
+            class: 'nav-badges',
+            style:
+              'display:flex;align-items:center;gap:8px;margin-left:12px;position:relative;'
+          },
+          [h(ZreadBadge), h(DeepWikiBadge)]
+        )
+    })
+  },
+  enhanceApp({ app }) {
+    app.component('ZreadBadge', ZreadBadge)
+    app.component('DeepWikiBadge', DeepWikiBadge)
+  }
+} satisfies Theme

package/docs/en/guide/api-common.md

@@ -0,0 +1,49 @@
+# Common API
+
+## splitText
+
+Feature: split text
+
+Usage：
+
+```javascript
+import { splitText } from '@hufe921/canvas-editor'
+
+splitText(text: string): string[]
+```
+
+## createDomFromElementList
+
+Feature: Create a DOM tree based on the elementList
+
+Usage：
+
+```javascript
+import { createDomFromElementList } from '@hufe921/canvas-editor'
+
+createDomFromElementList(elementList: IElement[], options?: IEditorOption): HTMLDivElement
+```
+
+## getElementListByHTML
+
+Feature: Create an elementList based on HTML
+
+Usage：
+
+```javascript
+import { getElementListByHTML } from '@hufe921/canvas-editor'
+
+getElementListByHTML(htmlText: string, options: IGetElementListByHTMLOption): IElement[]
+```
+
+## getTextFromElementList
+
+Feature: Create text based on elementList
+
+Usage：
+
+```javascript
+import { getTextFromElementList } from '@hufe921/canvas-editor'
+
+getTextFromElementList(elementList: IElement[]): string
+```

package/docs/en/guide/api-instance.md

@@ -0,0 +1,34 @@
+# Instance API
+
+## How to Use
+
+```javascript
+import Editor from "@hufe921/canvas-editor"
+
+const instance = new Editor(container, <IElement[]>data, options)
+instance.apiName()
+```
+
+## version
+
+Feature: version number
+
+Usage：
+
+```javascript
+instance.version
+```
+
+## destroy
+
+Feature: Destroy the editor
+
+Usage：
+
+```javascript
+instance.destroy()
+```
+
+::: warning
+Only destroy the editor DOM and related events, menu bars, toolbars, external variables, etc. need to be handled by themselves.
+:::