@wangeditor-next/plugin-ctrl-enter 3.0.2 → 6.1.1

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

@@ -5,7 +5,7 @@
 import { IDomEditor } from '@wangeditor-next/core';
 import { Descendant } from 'slate';
 import { DOMElement } from '../../utils/dom';
-import { Header1Element, Header2Element, Header3Element, Header4Element, Header5Element } from './custom-types';
+import { Header1Element, Header2Element, Header3Element, Header4Element, Header5Element, Header6Element } from './custom-types';
 export declare const parseHeader1HtmlConf: {
     selector: string;
     parseElemHtml: (elem: DOMElement, children: Descendant[], editor: IDomEditor) => Header1Element;
@@ -28,5 +28,5 @@ export declare const parseHeader5HtmlConf: {
 };
 export declare const parseHeader6HtmlConf: {
     selector: string;
-    parseElemHtml: (elem: DOMElement, children: Descendant[], editor: IDomEditor) => Header5Element;
+    parseElemHtml: (elem: DOMElement, children: Descendant[], editor: IDomEditor) => Header6Element;
 };

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

@@ -7,11 +7,12 @@ import type { IDomEditor } from './editor/interface';
 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 type { HtmlTransformFnType, 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, ISingleMenuConfig, IToolbarConfig, IUploadImageConfig, IUploadVideoConfig, StyleClassTokenType, TextStyleMode, } from './config/interface';
+export { EditorEvents } from './config/interface';
 export * from './config/style-mode';
 export * from './editor/dom-editor';
 export * from './editor/interface';
@@ -35,6 +36,7 @@ export interface IModuleConf {
     renderStyle: RenderStyleFnType;
     renderElems: Array<IRenderElemConf>;
     styleToHtml: styleToHtmlFnType;
+    htmlTransform?: HtmlTransformFnType;
     elemsToHtml: Array<IElemToHtmlConf>;
     preParseHtml: Array<IPreParseHtmlConf>;
     parseStyleHtml: ParseStyleHtmlFnType;

package/dist/core/src/to-html/index.d.ts

@@ -4,6 +4,7 @@
  */
 import { Descendant, Element as SlateElement } from 'slate';
 import { IDomEditor } from '../editor/interface';
+import type { INodeToHtmlOptions } from './node2html';
 export type styleToHtmlFnType = (node: Descendant, elemHtml: string, editor?: IDomEditor) => string;
 export declare const STYLE_TO_HTML_FN_LIST: styleToHtmlFnType[];
 /**
@@ -11,6 +12,17 @@ export declare const STYLE_TO_HTML_FN_LIST: styleToHtmlFnType[];
  * @param fn 处理 toHtml 文本样式的函数
  */
 export declare function registerStyleToHtmlHandler(fn: styleToHtmlFnType): void;
+/**
+ * Transform the HTML fragments of the document's top-level nodes.
+ *
+ * Element serializers intentionally stay node-local. Modules that need
+ * neighboring blocks to produce valid HTML (for example semantic lists) use
+ * this hook after every node has been serialized.
+ */
+export type HtmlTransformFnType = (htmlList: string[], nodes: Descendant[], editor: IDomEditor, options: INodeToHtmlOptions) => string[];
+export declare const HTML_TRANSFORM_HANDLER_LIST: HtmlTransformFnType[];
+export declare function registerHtmlTransformHandler(fn: HtmlTransformFnType): void;
+export declare function transformHtml(htmlList: string[], nodes: Descendant[], editor: IDomEditor, options?: INodeToHtmlOptions): string[];
 interface IElemToHtmlRes {
     html: string;
     prefix?: string;

package/dist/editor/src/Boot.d.ts

@@ -2,7 +2,7 @@
  * @description Editor View class
  * @author wangfupeng
  */
-import type { IEditorConfig, IElemToHtmlConf, IModuleConf, IParseElemHtmlConf, IPreParseHtmlConf, IRegisterMenuConf, IRenderElemConf, ISingleMenuConfig, IToolbarConfig, ParseStyleHtmlFnType, RenderStyleFnType, styleToHtmlFnType } from '@wangeditor-next/core';
+import type { HtmlTransformFnType, IEditorConfig, IElemToHtmlConf, IModuleConf, IParseElemHtmlConf, IPreParseHtmlConf, IRegisterMenuConf, IRenderElemConf, ISingleMenuConfig, IToolbarConfig, ParseStyleHtmlFnType, RenderStyleFnType, styleToHtmlFnType } from '@wangeditor-next/core';
 import { IDomEditor } from '@wangeditor-next/core';
 type PluginType = <T extends IDomEditor>(editor: T) => T;
 declare class Boot {
@@ -22,6 +22,7 @@ declare class Boot {
     static registerRenderStyle(fn: RenderStyleFnType): void;
     static registerElemToHtml(elemToHtmlConf: IElemToHtmlConf): void;
     static registerStyleToHtml(fn: styleToHtmlFnType): void;
+    static registerHtmlTransform(fn: HtmlTransformFnType): void;
     static registerPreParseHtml(preParseHtmlConf: IPreParseHtmlConf): void;
     static registerParseElemHtml(parseElemHtmlConf: IParseElemHtmlConf): void;
     static registerParseStyleHtml(fn: ParseStyleHtmlFnType): void;

package/dist/list-module/src/locale/en.d.ts

@@ -7,6 +7,9 @@ declare const _default: {
         unOrderedList: string;
         orderedList: string;
         lowerAlphaList: string;
+        numberingActions: string;
+        continueNumbering: string;
+        restartNumbering: string;
     };
 };
 export default _default;

package/dist/list-module/src/locale/zh-CN.d.ts

@@ -7,6 +7,9 @@ declare const _default: {
         unOrderedList: string;
         orderedList: string;
         lowerAlphaList: string;
+        numberingActions: string;
+        continueNumbering: string;
+        restartNumbering: string;
     };
 };
 export default _default;

package/dist/list-module/src/module/custom-types.d.ts

@@ -4,11 +4,24 @@
  */
 import { Text } from 'slate';
 export type OrderedListType = '1' | 'a' | 'A' | 'i' | 'I';
+/**
+ * An outline keeps the established list-item wire format and records the
+ * heading semantics as additive metadata.
+ */
+export type HeadingType = 'header1' | 'header2' | 'header3' | 'header4' | 'header5' | 'header6';
 export type ListItemElement = {
     type: 'list-item';
     ordered: boolean;
     level: number;
     start?: number;
     orderType?: OrderedListType;
+    headingType?: HeadingType;
+    listMode?: 'outline';
+    listRestart?: number;
     children: Text[];
 };
+export type OutlineListItemElement = ListItemElement & {
+    ordered: true;
+    headingType: HeadingType;
+    listMode: 'outline';
+};

package/dist/list-module/src/module/helpers.d.ts

@@ -1,15 +1,25 @@
 /**
- * @description table menu helpers
- * @author wangfupeng
+ * @description list helpers
  */
 import { IDomEditor } from '@wangeditor-next/core';
-import { ListItemElement, OrderedListType } from './custom-types';
+import { Node } from 'slate';
+import { HeadingType, ListItemElement, OrderedListType, OutlineListItemElement } from './custom-types';
+export declare function isListNode(node: Node): node is ListItemElement;
+export declare const isLegacyListItem: typeof isListNode;
+export declare function isHeadingType(value: unknown): value is HeadingType;
+export declare function getHeadingType(node: Node): HeadingType | null;
+export declare function getListIndent(node: Node): number;
+export declare function getListMode(node: Node): 'standard' | 'outline';
+export declare function isOutlineListNode(node: Node): node is OutlineListItemElement;
+export declare function getOutlineLevel(node: Node): number;
 export declare function getNormalizedOrderedListStart(elem: ListItemElement): number;
 export declare function getNormalizedOrderedListType(elem: ListItemElement): OrderedListType;
 export declare function hasSameListConfig(a: ListItemElement, b: ListItemElement): boolean;
+export declare function getOrderedItemNumber(editor: IDomEditor, elem: ListItemElement): number;
+export declare function getOutlineNumber(editor: IDomEditor, elem: ListItemElement): string;
 /**
  * 获取上一个同一 level 的 list item
- * @param editor 编辑器实例
+ * @param editor editor
  * @param elem elem
  */
 export declare function getBrotherListNodeByLevel(editor: IDomEditor, elem: ListItemElement, level?: number): ListItemElement | null;

package/dist/list-module/src/module/html-transform.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @description compose semantic outline HTML from additive list-item metadata
+ */
+import { HtmlTransformFnType } from '@wangeditor-next/core';
+/**
+ * List-item serialization remains backward compatible for ordinary lists.
+ * Only outline list items need document-level composition to create valid
+ * `ol > li > hN` structure.
+ */
+export declare const transformListHtml: HtmlTransformFnType;

package/dist/list-module/src/module/menu/BaseMenu.d.ts

@@ -1,5 +1,5 @@
 /**
- * @description base menu
+ * @description list menu base class
  * @author wangfupeng
  */
 import { IButtonMenu, IDomEditor } from '@wangeditor-next/core';
@@ -11,7 +11,7 @@ declare abstract class BaseMenu implements IButtonMenu {
     abstract readonly title: string;
     abstract readonly iconSvg: string;
     readonly tag = "button";
-    private getListNode;
+    private isTargetListNode;
     getValue(_editor: IDomEditor): string | boolean;
     isActive(editor: IDomEditor): boolean;
     isDisabled(editor: IDomEditor): boolean;

package/dist/list-module/src/module/outline-actions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description outline numbering marker actions
+ */
+import { IDomEditor } from '@wangeditor-next/core';
+import { ListItemElement } from './custom-types';
+export declare function continueOutlineNumbering(editor: IDomEditor, node: ListItemElement): void;
+export declare function restartOutlineNumbering(editor: IDomEditor, node: ListItemElement): void;
+export declare function hideOutlineActionPanel(editor: IDomEditor): void;
+export declare function showOutlineActionPanel(editor: IDomEditor, node: ListItemElement, marker: HTMLElement): void;

package/dist/list-module/src/module/parse-elem-html.d.ts

@@ -1,6 +1,5 @@
 /**
- * @description parse elem html
- * @author wangfupeng
+ * @description parse list HTML
  */
 import { IDomEditor } from '@wangeditor-next/core';
 import { Descendant } from 'slate';

package/dist/list-module/src/module/plugin.d.ts

@@ -1,5 +1,5 @@
 /**
- * @description editor 插件，重写 editor API
+ * @description list editor plugin
  * @author wangfupeng
  */
 import { IDomEditor } from '@wangeditor-next/core';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wangeditor-next/plugin-ctrl-enter",
-  "version": "3.0.2",
+  "version": "6.1.1",
   "description": "wangEditor ctrl+enter plugin",
   "author": "cycleccc <2991205548@qq.com>",
   "type": "module",
@@ -34,7 +34,7 @@
     "url": "https://github.com/wangeditor-next/wangEditor-next/issues"
   },
   "peerDependencies": {
-    "@wangeditor-next/editor": "6.0.2"
+    "@wangeditor-next/editor": "^6.1.1"
   },
   "devDependencies": {
     "@wangeditor-next-shared/rollup-config": "^0.0.2"