@wangeditor-next/editor 6.4.0 → 6.4.2

package/README.md

@@ -57,5 +57,26 @@ const { editor, toolbar } = factory.create({
 import { createUploader } from '@wangeditor-next/editor/upload'
 ```
 
+## 图片尺寸单位和校验
+
+可通过 `imageResize` 统一配置编辑器内置的图片缩放入口。设置 `resizeUnit: 'px'` 后，修改尺寸、快捷尺寸和拖拽缩放都会使用 px：
+
+```ts
+const editorConfig: Partial<IEditorConfig> = {
+  imageResize: {
+    resizeUnit: 'px',
+    resizeOptions: [
+      { label: '200px', value: '200px' },
+    ],
+    checkImageSize({ width, height, source }) {
+      if (Number.parseFloat(width) > 1200) return '图片宽度不能超过 1200px'
+      return true
+    },
+  },
+}
+```
+
+不配置 `imageResize` 时保持历史行为。HTML 导入仍按原有解析规则处理，避免导入导出回环丢失尺寸信息。
+
 交流
 - [提交问题和建议](https://github.com/wangeditor-next/wangEditor-next/issues)

package/dist/basic-modules/src/modules/image/menu/WidthBase.d.ts

@@ -7,6 +7,7 @@ declare abstract class ImageWidthBaseClass implements IButtonMenu {
     abstract readonly title: string;
     readonly tag = "button";
     abstract readonly value: string;
+    getTitle(editor: IDomEditor): string;
     getValue(_editor: IDomEditor): string | boolean;
     isActive(_editor: IDomEditor): boolean;
     private getSelectedNode;

package/dist/basic-modules/src/modules/image/resize.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description shared image resize policy
+ */
+import { IDomEditor, IImageResizeOption, ImageResizeSource, ImageResizeUnit } from '@wangeditor-next/core';
+import { Node } from 'slate';
+export interface IImageResizeResult {
+    width: string;
+    height: string;
+}
+export declare function getImageResizePreset(editor: IDomEditor, defaultValue: string): IImageResizeOption;
+/** Normalize a user value, returning null when it violates a configured unit. */
+export declare function normalizeImageSize(value: string, unit?: ImageResizeUnit, source?: ImageResizeSource): string | null;
+export declare function validateImageSize(editor: IDomEditor, rawWidth: string, rawHeight: string, source: ImageResizeSource): IImageResizeResult | null;
+export declare function updateImageSize(editor: IDomEditor, imageNode: Node, rawWidth: string, rawHeight: string, source: ImageResizeSource): boolean;

package/dist/basic-modules/src/modules/link/parse-elem-html.d.ts

@@ -5,8 +5,9 @@
 import { IDomEditor } from '@wangeditor-next/core';
 import { Descendant } from 'slate';
 import { DOMElement } from '../../utils/dom';
+import { ImageElement } from '../image/custom-types';
 import { LinkElement } from './custom-types';
-declare function parseHtml(elem: DOMElement, children: Descendant[], editor: IDomEditor): LinkElement;
+declare function parseHtml(elem: DOMElement, children: Descendant[], editor: IDomEditor): LinkElement | ImageElement;
 export declare const parseHtmlConf: {
     selector: string;
     parseElemHtml: typeof parseHtml;

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

@@ -112,6 +112,27 @@ interface IInsertImageConfig extends IImageMenuBaseConfig {
 interface IEditImageConfig extends IImageMenuBaseConfig {
     onUpdatedImage?: (imageNode: ImageElement | null) => void;
 }
+export type ImageResizeUnit = 'px' | '%';
+export type ImageResizeSource = 'modal' | 'preset' | 'drag';
+export interface IImageResizeCheckPayload {
+    width: string;
+    height: string;
+    rawWidth: string;
+    rawHeight: string;
+    source: ImageResizeSource;
+}
+export interface IImageResizeOption {
+    label: string;
+    value: string;
+}
+export interface IImageResizeConfig {
+    /** Resize unit for editor-owned image resize actions. Omit to preserve legacy behavior. */
+    resizeUnit?: ImageResizeUnit;
+    /** Values for the built-in 30%/50%/100% preset buttons, in their existing order. */
+    resizeOptions?: IImageResizeOption[];
+    /** Validate normalized image dimensions before they are written to the document. */
+    checkImageSize?: (payload: IImageResizeCheckPayload) => boolean | undefined | string;
+}
 interface IEmotionConfig {
     emotions: string[];
 }
@@ -281,6 +302,7 @@ export interface IEditorConfig {
     autoFocus: boolean;
     decorate?: (nodeEntry: NodeEntry) => Range[];
     maxLength?: number;
+    imageResize?: IImageResizeConfig;
     MENU_CONF?: IMenuConfigUpdate;
     hoverbarKeys?: IHoverbarConf;
     EXTEND_CONF?: any;

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

@@ -11,7 +11,7 @@ import type { HtmlTransformFnType, IElemToHtmlConf, styleToHtmlFnType } from './
 import createUploaderRuntime from './upload/createUploader';
 import type { IUploadConfig } from './upload/interface';
 export * from './create/index';
-export type { ClassStylePolicy, IClassStyleUnsupportedPayload, IEditorConfig, ISingleMenuConfig, IToolbarConfig, IUploadImageConfig, IUploadVideoConfig, StyleClassTokenType, TextStyleMode, } from './config/interface';
+export type { ClassStylePolicy, IClassStyleUnsupportedPayload, IEditorConfig, IImageResizeCheckPayload, IImageResizeConfig, IImageResizeOption, ImageResizeSource, ImageResizeUnit, ISingleMenuConfig, IToolbarConfig, IUploadImageConfig, IUploadVideoConfig, StyleClassTokenType, TextStyleMode, } from './config/interface';
 export { EditorEvents } from './config/interface';
 export * from './config/style-mode';
 export * from './editor/dom-editor';