@wangeditor-next/editor 5.7.0 → 5.7.1

package/README.md

@@ -9,5 +9,53 @@
 
 ![](../../docs/images/editor.png)
 
+## 体积优化（按需模块）
+
+默认入口 `@wangeditor-next/editor` 会自动注册全部内置模块（表格、上传、代码高亮等）。
+如果业务只用到部分能力，建议使用同包轻量入口 `@wangeditor-next/editor/core`。
+该入口不会自动注册内置模块，且不包含上传运行时代码；如需二次开发上传能力，可从
+`@wangeditor-next/editor/upload`
+引入 `createUploader`。
+
+```ts
+import { createEditorFactory } from '@wangeditor-next/editor/core'
+import basicModules from '@wangeditor-next/basic-modules'
+import wangEditorListModule from '@wangeditor-next/list-module'
+
+const factory = createEditorFactory({
+  // tiptap-like：按 extensions 组合功能
+  extensions: [...basicModules, wangEditorListModule],
+  toolbarConfig: {
+    toolbarKeys: [
+      'headerSelect',
+      'bold',
+      'italic',
+      '|',
+      'bulletedList',
+      'numberedList',
+      '|',
+      'undo',
+      'redo',
+    ],
+  },
+})
+
+const { editor, toolbar } = factory.create({
+  editor: {
+    selector: '#editor',
+    config: {
+      hoverbarKeys: {},
+    },
+  },
+  toolbar: {
+    selector: '#toolbar',
+  },
+})
+```
+
+```ts
+import { createUploader } from '@wangeditor-next/editor/upload'
+```
+
 交流
 - [提交问题和建议](https://github.com/wangeditor-next/wangEditor-next/issues)

package/dist/core/src/config/interface.d.ts

@@ -7,7 +7,7 @@ import type { VideoElement } from 'packages/video-module/src/module/custom-types
 import type { Descendant, Node, NodeEntry, Range } from 'slate';
 import type { IDomEditor } from '../editor/interface';
 import type { IMenuGroup } from '../menus/interface';
-import type { IUploadConfig } from '../upload';
+import type { IUploadConfig } from '../upload/interface';
 import type { DOMElement } from '../utils/dom';
 interface IHoverbarConf {
     [key: string]: {

package/dist/core/src/editor/dom-editor.d.ts

@@ -54,6 +54,15 @@ export declare const DomEditor: {
      * Find the native DOM element from a Slate node or editor.
      */
     toDOMNode(editor: IDomEditor, node: Node): HTMLElement;
+    /**
+     * Check if a Slate node currently has a mapped DOM node.
+     * During IME/composition transitions the Slate tree can update before DOM patching finishes.
+     */
+    hasDOMNodeBySlateNode(editor: IDomEditor, node: Node): boolean;
+    /**
+     * Check if both range endpoints can be resolved to DOM nodes right now.
+     */
+    canResolveDOMRange(editor: IDomEditor, range: Range): boolean;
     /**
      * Check if a DOM node is within the editor.
      */

package/dist/core/src/index.d.ts

@@ -8,6 +8,8 @@ import type { IRegisterMenuConf } from './menus/index';
 import type { IParseElemHtmlConf, IPreParseHtmlConf, ParseStyleHtmlFnType } from './parse-html/index';
 import type { IRenderElemConf, RenderStyleFnType } from './render/index';
 import type { IElemToHtmlConf, styleToHtmlFnType } from './to-html/index';
+import createUploaderRuntime from './upload/createUploader';
+import type { IUploadConfig } from './upload/interface';
 export * from './create/index';
 export type { ClassStylePolicy, IClassStyleUnsupportedPayload, IEditorConfig, IToolbarConfig, IUploadImageConfig, IUploadVideoConfig, StyleClassTokenType, TextStyleMode, } from './config/interface';
 export * from './config/style-mode';
@@ -17,7 +19,15 @@ export * from './render/index';
 export * from './to-html/index';
 export * from './parse-html/index';
 export * from './menus/index';
-export * from './upload/index';
+export type { IUploadAdapter, IUploadAdapterContext, IUploadConfig, IUploader, IUploadFile, IUploadResultFile, } from './upload/interface';
+/**
+ * @deprecated Please import from `@wangeditor-next/core/upload`.
+ */
+export declare const createUploader: typeof createUploaderRuntime;
+/**
+ * @deprecated Please import from `@wangeditor-next/core/upload`.
+ */
+export declare function createUppyUploader(config: IUploadConfig): import("./upload/interface").IUploader;
 export * from './i18n/index';
 export * from './utils/dom';
 export interface IModuleConf {

package/dist/core/src/upload.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @description upload entry
+ * @author cycleccc
+ */
+export * from './upload/index';