@wangeditor-next/yjs-for-react 0.1.7 → 0.1.8

package/dist/basic-modules/src/modules/link/menu/config.d.ts

@@ -8,7 +8,7 @@ export declare function genLinkMenuConfig(): {
      * @param text link text
      * @param url link url
      */
-    checkLink(text: string, url: string): boolean | string | undefined;
+    checkLink(_text: string, _url: string): boolean | string | undefined;
     /**
      * parse link url
      * @param url url

package/dist/basic-modules/src/modules/link/menu/index.d.ts

@@ -10,7 +10,7 @@ declare const insertLinkMenuConf: {
     key: string;
     factory(): InsertLink;
     config: {
-        checkLink(text: string, url: string): boolean | string | undefined;
+        checkLink(_text: string, _url: string): boolean | string | undefined;
         parseLinkUrl(url: string): string;
     };
 };
@@ -18,7 +18,7 @@ declare const editLinkMenuConf: {
     key: string;
     factory(): EditLink;
     config: {
-        checkLink(text: string, url: string): boolean | string | undefined;
+        checkLink(_text: string, _url: string): boolean | string | undefined;
         parseLinkUrl(url: string): string;
     };
 };

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

@@ -2,9 +2,12 @@
  * @description config interface
  * @author wangfupeng
  */
-import { Range, NodeEntry, Node } from 'slate';
+import { ImageElement } from 'packages/basic-modules/src/modules/image/custom-types';
+import { VideoElement } from 'packages/video-module/src/module/custom-types';
+import { Node, NodeEntry, Range } from 'slate';
 import { IDomEditor } from '../editor/interface';
 import { IMenuGroup } from '../menus/interface';
+import { IUploadConfig } from '../upload';
 interface IHoverbarConf {
     [key: string]: {
         match?: (editor: IDomEditor, n: Node) => boolean;
@@ -14,9 +17,139 @@ interface IHoverbarConf {
 export type AlertType = 'success' | 'info' | 'warning' | 'error';
 export interface ISingleMenuConfig {
     [key: string]: any;
+    iconSvg?: string;
+}
+interface IColorConfig {
+    colors: string[];
+}
+interface IFontSizeItem {
+    name: string;
+    value: string;
+}
+interface IFontSizeConfig {
+    fontSizeList: (string | IFontSizeItem)[];
+}
+interface IFontFamilyItem {
+    name: string;
+    value: string;
+}
+interface IFontFamilyConfig {
+    fontFamilyList: (string | IFontFamilyItem)[];
+}
+interface ILineHeightConfig {
+    lineHeightList: string[];
+}
+interface IImageMenuBaseConfig {
+    checkImage?: (src: string, alt: string, url: string) => boolean | undefined | string;
+    parseImageSrc?: (src: string) => string;
+}
+interface IInsertImageConfig extends IImageMenuBaseConfig {
+    onInsertedImage?: (imageNode: ImageElement | null) => void;
+}
+interface IEditImageConfig extends IImageMenuBaseConfig {
+    onUpdatedImage?: (imageNode: ImageElement | null) => void;
+}
+interface IEmotionConfig {
+    emotions: string[];
+}
+interface IInsertTableConfig {
+    minWidth: number;
+    tableHeader: {
+        selected: boolean;
+    };
+    tableFullWidth: {
+        selected: boolean;
+    };
+}
+interface ILinkConfig {
+    checkLink: (text: string, url: string) => string | boolean | undefined;
+    parseLinkUrl: (url: string) => string;
+}
+interface IInsertVideoConfig {
+    onInsertedVideo: (videoNode: VideoElement) => NodeEntry | Range;
+    checkVideo: (src: string, poster: string) => string | boolean | undefined;
+    parseVideoSrc: (url: string) => string;
+}
+interface IUploadVideoConfig extends IUploadConfig {
+}
+interface IUploadImageConfig extends IUploadConfig {
+    base64LimitSize?: number;
+}
+interface ICodeLangConfig {
+    codeLangs: {
+        text: string;
+        value: string;
+    }[];
 }
 export interface IMenuConfig {
-    [key: string]: ISingleMenuConfig;
+    bold: ISingleMenuConfig;
+    underline: ISingleMenuConfig;
+    italic: ISingleMenuConfig;
+    through: ISingleMenuConfig;
+    code: ISingleMenuConfig;
+    sub: ISingleMenuConfig;
+    sup: ISingleMenuConfig;
+    clearStyle: ISingleMenuConfig;
+    color: IColorConfig;
+    bgColor: IColorConfig;
+    fontSize: IFontSizeConfig;
+    fontFamily: IFontFamilyConfig;
+    indent: ISingleMenuConfig;
+    delIndent: ISingleMenuConfig;
+    justifyLeft: ISingleMenuConfig;
+    justifyRight: ISingleMenuConfig;
+    justifyCenter: ISingleMenuConfig;
+    justifyJustify: ISingleMenuConfig;
+    lineHeight: ILineHeightConfig;
+    insertImage: IInsertImageConfig;
+    deleteImage: ISingleMenuConfig;
+    editImage: IEditImageConfig;
+    viewImageLink: ISingleMenuConfig;
+    imageWidth30: ISingleMenuConfig;
+    imageWidth50: ISingleMenuConfig;
+    imageWidth100: ISingleMenuConfig;
+    editorImageSizeMenu: ISingleMenuConfig;
+    divider: ISingleMenuConfig;
+    emotion: IEmotionConfig;
+    insertLink: ILinkConfig;
+    editLink: ILinkConfig;
+    unLink: ISingleMenuConfig;
+    viewLink: ISingleMenuConfig;
+    codeBlock: ISingleMenuConfig;
+    blockquote: ISingleMenuConfig;
+    headerSelect: ISingleMenuConfig;
+    header1: ISingleMenuConfig;
+    header2: ISingleMenuConfig;
+    header3: ISingleMenuConfig;
+    header4: ISingleMenuConfig;
+    header5: ISingleMenuConfig;
+    header6: ISingleMenuConfig;
+    todo: ISingleMenuConfig;
+    formatPainter: ISingleMenuConfig;
+    redo: ISingleMenuConfig;
+    undo: ISingleMenuConfig;
+    fullScreen: ISingleMenuConfig;
+    enter: ISingleMenuConfig;
+    bulletedList: ISingleMenuConfig;
+    numberedList: ISingleMenuConfig;
+    insertTable: ISingleMenuConfig;
+    deleteTable: ISingleMenuConfig;
+    insertTableRow: IInsertTableConfig;
+    deleteTableRow: ISingleMenuConfig;
+    insertTableCol: ISingleMenuConfig;
+    deleteTableCol: ISingleMenuConfig;
+    tableHeader: ISingleMenuConfig;
+    tableFullWidth: ISingleMenuConfig;
+    mergeTableCell: ISingleMenuConfig;
+    splitTableCell: ISingleMenuConfig;
+    setTableProperty: ISingleMenuConfig;
+    setTableCellProperty: ISingleMenuConfig;
+    insertVideo: IInsertVideoConfig;
+    uploadVideo: IUploadVideoConfig;
+    editVideoSize: ISingleMenuConfig;
+    editVideoSrc: ISingleMenuConfig;
+    uploadImage: IUploadImageConfig;
+    codeSelectLang: ICodeLangConfig;
 }
 /**
  * editor config
@@ -39,7 +172,7 @@ export interface IEditorConfig {
     autoFocus: boolean;
     decorate?: (nodeEntry: NodeEntry) => Range[];
     maxLength?: number;
-    MENU_CONF?: IMenuConfig;
+    MENU_CONF?: Partial<IMenuConfig>;
     hoverbarKeys?: IHoverbarConf;
     EXTEND_CONF?: any;
 }

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

@@ -3,7 +3,7 @@
  * @author wangfupeng
  */
 import { IMenuConfig, ISingleMenuConfig } from '../config/interface';
-export declare const GLOBAL_MENU_CONF: IMenuConfig;
+export declare const GLOBAL_MENU_CONF: Partial<IMenuConfig>;
 /**
  * 注册全局菜单配置
  * @param key menu key

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

@@ -2,14 +2,15 @@
  * @description editor interface
  * @author wangfupeng
  */
-import { Editor, Location, Node, Ancestor, Element } from 'slate';
 import ee from 'event-emitter';
-import { IEditorConfig, AlertType, ISingleMenuConfig } from '../config/interface';
+import { Ancestor, Editor, Element, Location, Node } from 'slate';
+import { AlertType, IEditorConfig, IMenuConfig, ISingleMenuConfig } from '../config/interface';
 import { IPositionStyle } from '../menus/interface';
 import { DOMElement } from '../utils/dom';
 export type ElementWithId = Element & {
     id: string;
 };
+export type getMenuConfigReturnType<K> = K extends keyof IMenuConfig ? IMenuConfig[K] : ISingleMenuConfig;
 /**
  * 扩展 slate Editor 接口
  */
@@ -17,7 +18,7 @@ export interface IDomEditor extends Editor {
     insertData: (data: DataTransfer) => void;
     setFragmentData: (data: Pick<DataTransfer, 'getData' | 'setData'>) => void;
     getConfig: () => IEditorConfig;
-    getMenuConfig: (menuKey: string) => ISingleMenuConfig;
+    getMenuConfig: <K extends string>(menuKey: K) => getMenuConfigReturnType<K>;
     getAllMenuKeys: () => string[];
     alert: (info: string, type: AlertType) => void;
     handleTab: () => void;

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

@@ -3,6 +3,7 @@
  * @author wangfupeng
  */
 import { Node } from 'slate';
+import { ISingleMenuConfig } from '../config/interface';
 import { IDomEditor } from '../editor/interface';
 import { DOMElement } from '../utils/dom';
 export interface IMenuGroup {
@@ -59,8 +60,6 @@ export type MenuFactoryType = () => IButtonMenu | ISelectMenu | IDropPanelMenu |
 export interface IRegisterMenuConf {
     key: string;
     factory: MenuFactoryType;
-    config?: {
-        [key: string]: any;
-    };
+    config?: ISingleMenuConfig;
 }
 export {};

package/dist/core/src/menus/register.d.ts

@@ -2,7 +2,8 @@
  * @description register menu
  * @author wangfupeng
  */
-import { MenuFactoryType, IRegisterMenuConf } from './interface';
+import { ISingleMenuConfig } from '../config/interface';
+import { IRegisterMenuConf, MenuFactoryType } from './interface';
 export declare const MENU_ITEM_FACTORIES: {
     [key: string]: MenuFactoryType;
 };
@@ -11,6 +12,4 @@ export declare const MENU_ITEM_FACTORIES: {
  * @param registerMenuConf { key, factory, config } ，各个 menu key 不能重复
  * @param customConfig 自定义 menu config
  */
-export declare function registerMenu(registerMenuConf: IRegisterMenuConf, customConfig?: {
-    [key: string]: any;
-}): void;
+export declare function registerMenu(registerMenuConf: IRegisterMenuConf, customConfig?: ISingleMenuConfig): void;

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

@@ -2,7 +2,8 @@
  * @description Editor View class
  * @author wangfupeng
  */
-import { IDomEditor, IEditorConfig, IToolbarConfig, IModuleConf, IRegisterMenuConf, IRenderElemConf, RenderStyleFnType, IElemToHtmlConf, styleToHtmlFnType, IPreParseHtmlConf, ParseStyleHtmlFnType, IParseElemHtmlConf } from '@wangeditor-next/core';
+import { IDomEditor, IEditorConfig, IElemToHtmlConf, IModuleConf, IParseElemHtmlConf, IPreParseHtmlConf, IRegisterMenuConf, IRenderElemConf, IToolbarConfig, ParseStyleHtmlFnType, RenderStyleFnType, styleToHtmlFnType } from '@wangeditor-next/core';
+import { ISingleMenuConfig } from 'packages/core/src/config/interface';
 type PluginType = <T extends IDomEditor>(editor: T) => T;
 declare class Boot {
     constructor();
@@ -16,9 +17,7 @@ declare class Boot {
     static setSimpleToolbarConfig(newConfig?: Partial<IToolbarConfig>): void;
     static plugins: PluginType[];
     static registerPlugin(plugin: PluginType): void;
-    static registerMenu(menuConf: IRegisterMenuConf, customConfig?: {
-        [key: string]: any;
-    }): void;
+    static registerMenu(menuConf: IRegisterMenuConf, customConfig?: ISingleMenuConfig): void;
     static registerRenderElem(renderElemConf: IRenderElemConf): void;
     static registerRenderStyle(fn: RenderStyleFnType): void;
     static registerElemToHtml(elemToHtmlConf: IElemToHtmlConf): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wangeditor-next/yjs-for-react",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "React specific components/utils for wangeditor-next-yjs.",
   "author": "cycleccc <2991205548@qq.com>",
   "type": "module",
@@ -55,9 +55,9 @@
     "y-protocols": "^1.0.5"
   },
   "peerDependencies": {
-    "@wangeditor-next/core": "1.7.8",
-    "@wangeditor-next/editor": "5.6.0",
-    "@wangeditor-next/yjs": "^0.1.6",
+    "@wangeditor-next/core": "1.7.9",
+    "@wangeditor-next/editor": "5.6.1",
+    "@wangeditor-next/yjs": "^0.1.7",
     "react": ">=16.8.0",
     "slate": "^0.72.0",
     "yjs": "^13.5.29"