@wangeditor-next/yjs-for-react 0.1.4 → 0.1.6

package/dist/core/src/menus/bar/Toolbar.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @description classic toolbar
+ * @author wangfupeng
+ */
+import { Dom7Array, DOMElement } from '../../utils/dom';
+import { IButtonMenu, ISelectMenu, IDropPanelMenu, IModalMenu } from '../interface';
+import { IToolbarConfig } from '../../config/interface';
+type MenuType = IButtonMenu | ISelectMenu | IDropPanelMenu | IModalMenu;
+declare class Toolbar {
+    $box: Dom7Array;
+    private readonly $toolbar;
+    private menus;
+    private toolbarItems;
+    private config;
+    private lngListen;
+    constructor(boxSelector: string | DOMElement, config: Partial<IToolbarConfig>);
+    getMenus(): {
+        [key: string]: MenuType;
+    };
+    getConfig(): Partial<IToolbarConfig>;
+    private initToolbar;
+    private registerItems;
+    private registerGroup;
+    private registerSingleItem;
+    private getEditorInstance;
+    /**
+     * editor onChange 时触发（涉及 DOM 操作，加防抖）
+     */
+    changeToolbarState: any;
+    /**
+     * 销毁 toolbar
+     */
+    destroy(): void;
+}
+export default Toolbar;

package/dist/core/src/menus/bar-item/BaseButton.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @description base button class
+ * @author wangfupeng
+ */
+import { IButtonMenu, IDropPanelMenu, IModalMenu } from '../interface';
+import { Dom7Array } from '../../utils/dom';
+import { IBarItem } from './index';
+declare abstract class BaseButton implements IBarItem {
+    readonly $elem: Dom7Array;
+    protected readonly $button: Dom7Array;
+    menu: IButtonMenu | IDropPanelMenu | IModalMenu;
+    private disabled;
+    constructor(key: string, menu: IButtonMenu | IDropPanelMenu | IModalMenu, inGroup?: boolean);
+    private init;
+    /**
+     * 执行 menu.exec
+     */
+    private exec;
+    abstract onButtonClick(): void;
+    private setActive;
+    private setDisabled;
+    private setIcon;
+    private setTooltip;
+    changeMenuState(): void;
+}
+export default BaseButton;

package/dist/core/src/menus/bar-item/DropPanelButton.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description dropPanel button class
+ * @author wangfupeng
+ */
+import { IDropPanelMenu } from '../interface';
+import BaseButton from './BaseButton';
+declare class DropPanelButton extends BaseButton {
+    private dropPanel;
+    menu: IDropPanelMenu;
+    constructor(key: string, menu: IDropPanelMenu, inGroup?: boolean);
+    onButtonClick(): void;
+    private handleDropPanel;
+}
+export default DropPanelButton;

package/dist/core/src/menus/bar-item/GroupButton.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @description group button class
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+import { IMenuGroup } from '../interface';
+import { IBarItem } from './index';
+declare class GroupButton {
+    readonly $elem: Dom7Array;
+    private readonly $container;
+    readonly $button: Dom7Array;
+    constructor(menu: IMenuGroup);
+    appendBarItem(barItem: IBarItem): void;
+    private observe;
+    private createObserver;
+}
+export default GroupButton;

package/dist/core/src/menus/bar-item/ModalButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @description modal button class
+ * @author wangfupeng
+ */
+import { IModalMenu } from '../interface';
+import BaseButton from './BaseButton';
+declare class ModalButton extends BaseButton {
+    private $body;
+    private modal;
+    menu: IModalMenu;
+    constructor(key: string, menu: IModalMenu, inGroup?: boolean);
+    onButtonClick(): void;
+    /**
+     * 获取 modal 定位
+     */
+    private getPosition;
+    private handleModal;
+    /**
+     * 渲染并显示 modal
+     * @param modal modal
+     * @param firstTime 是否第一次显示 modal
+     */
+    private renderAndShowModal;
+}
+export default ModalButton;

package/dist/core/src/menus/bar-item/Select.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @description select
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+import { IBarItem } from './index';
+import { ISelectMenu } from '../interface';
+declare class BarItemSelect implements IBarItem {
+    readonly $elem: Dom7Array;
+    private readonly $button;
+    menu: ISelectMenu;
+    private disabled;
+    private selectList;
+    constructor(key: string, menu: ISelectMenu, inGroup?: boolean);
+    private init;
+    private trigger;
+    private onChange;
+    private setSelectedValue;
+    private setDisabled;
+    changeMenuState(): void;
+}
+export default BarItemSelect;

package/dist/core/src/menus/bar-item/SimpleButton.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description button class
+ * @author wangfupeng
+ */
+import { IButtonMenu } from '../interface';
+import BaseButton from './BaseButton';
+declare class SimpleButton extends BaseButton {
+    constructor(key: string, menu: IButtonMenu, inGroup?: boolean);
+    onButtonClick(): void;
+}
+export default SimpleButton;

package/dist/core/src/menus/bar-item/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @description bar item
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+import { IButtonMenu, ISelectMenu, IDropPanelMenu, IModalMenu, IMenuGroup } from '../interface';
+import { IDomEditor } from '../../editor/interface';
+import GroupButton from './GroupButton';
+type MenuType = IButtonMenu | ISelectMenu | IDropPanelMenu | IModalMenu;
+export interface IBarItem {
+    $elem: Dom7Array;
+    menu: MenuType;
+    changeMenuState: () => void;
+}
+export declare function getEditorInstance(item: IBarItem): IDomEditor;
+/**
+ * 创建 bar button/select
+ * @param key menu key
+ * @param menu menu
+ * @param inGroup 在 groupButton 中
+ */
+export declare function createBarItem(key: string, menu: MenuType, inGroup?: boolean): IBarItem;
+export declare function createBarItemGroup(menu: IMenuGroup): GroupButton;
+export {};

package/dist/core/src/menus/bar-item/tooltip.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @description tooltip 功能
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+export declare function addTooltip($button: Dom7Array, iconSvg: string, title: string, hotkey?: string, inGroup?: boolean): void;

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

@@ -0,0 +1,18 @@
+/**
+ * @description menu helpers
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+/**
+ * 清理 svg 的样式
+ * @param $elem svg elem
+ */
+export declare function clearSvgStyle($elem: Dom7Array): void;
+/**
+ * 向下箭头 icon svg
+ */
+export declare function gen$downArrow(): Dom7Array;
+/**
+ * bar item 分割线
+ */
+export declare function gen$barItemDivider(): Dom7Array;

package/dist/core/src/menus/helpers/position.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @description menu position helpers
+ * @author wangfupeng
+ */
+import { Node } from 'slate';
+import { IDomEditor } from '../../editor/interface';
+import { Dom7Array } from '../../utils/dom';
+import { IPositionStyle } from '../interface';
+/**
+ * 获取 textContainer 尺寸和定位
+ * @param editor editor
+ */
+export declare function getTextContainerRect(editor: IDomEditor): {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+} | null;
+/**
+ * 根据选区，计算定位（用于 modal hoverbar）
+ * @param editor editor
+ */
+export declare function getPositionBySelection(editor: IDomEditor): Partial<IPositionStyle>;
+/**
+ * 根据 node ，计算定位（用于 modal hoverbar）
+ * @param editor editor
+ * @param node slate node
+ * @param type 'modal'/'bar'
+ */
+export declare function getPositionByNode(editor: IDomEditor, node: Node, type?: string): Partial<IPositionStyle>;
+/**
+ * 异步修正 position ，不能超出 textContainer 边界
+ * @param editor editor
+ * @param $positionElem modal/bar
+ */
+export declare function correctPosition(editor: IDomEditor, $positionElem: Dom7Array): void;

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

@@ -0,0 +1,9 @@
+/**
+ * @description menus entry
+ * @author wangfupeng
+ */
+import Toolbar from './bar/Toolbar';
+export { registerMenu } from './register';
+export { IButtonMenu, ISelectMenu, IDropPanelMenu, IModalMenu, IRegisterMenuConf, IOption, } from './interface';
+export { genModalInputElems, genModalButtonElems, genModalTextareaElems, } from './panel-and-modal/Modal';
+export { Toolbar };

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

@@ -0,0 +1,66 @@
+/**
+ * @description menu interface
+ * @author wangfupeng
+ */
+import { Node } from 'slate';
+import { IDomEditor } from '../editor/interface';
+import { DOMElement } from '../utils/dom';
+export interface IMenuGroup {
+    key: string;
+    title: string;
+    iconSvg?: string;
+    menuKeys: string[];
+}
+export interface IPositionStyle {
+    top: string;
+    left: string;
+    right: string;
+    bottom: string;
+}
+export interface IOption {
+    value: string;
+    text: string;
+    selected?: boolean;
+    styleForRenderMenuList?: {
+        [key: string]: string;
+    };
+}
+interface IBaseMenu {
+    readonly title: string;
+    iconSvg?: string;
+    readonly hotkey?: string;
+    readonly alwaysEnable?: boolean;
+    readonly tag: string;
+    readonly width?: number;
+    getValue: (editor: IDomEditor) => string | boolean;
+    getIcon?: (editor: IDomEditor) => string;
+    getTitle?: (editor: IDomEditor) => string;
+    isActive: (editor: IDomEditor) => boolean;
+    isDisabled: (editor: IDomEditor) => boolean;
+    exec: (editor: IDomEditor, value: string | boolean) => void;
+}
+export interface IButtonMenu extends IBaseMenu {
+}
+export interface ISelectMenu extends IBaseMenu {
+    readonly selectPanelWidth?: number;
+    getOptions: (editor: IDomEditor) => IOption[];
+}
+export interface IDropPanelMenu extends IBaseMenu {
+    readonly showDropPanel: boolean;
+    getPanelContentElem: (editor: IDomEditor) => DOMElement;
+}
+export interface IModalMenu extends IBaseMenu {
+    readonly showModal: boolean;
+    readonly modalWidth: number;
+    getModalContentElem: (editor: IDomEditor) => DOMElement;
+    getModalPositionNode: (editor: IDomEditor) => Node | null;
+}
+export type MenuFactoryType = () => IButtonMenu | ISelectMenu | IDropPanelMenu | IModalMenu;
+export interface IRegisterMenuConf {
+    key: string;
+    factory: MenuFactoryType;
+    config?: {
+        [key: string]: any;
+    };
+}
+export {};

package/dist/core/src/menus/panel-and-modal/BaseClass.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @description panel modal baseClass
+ * @author wangfupeng
+ */
+import { IDomEditor } from '../../editor/interface';
+import { Dom7Array, DOMElement } from '../../utils/dom';
+declare abstract class PanelAndModal {
+    abstract readonly type: string;
+    abstract readonly $elem: Dom7Array;
+    isShow: boolean;
+    private showTime;
+    constructor(editor: IDomEditor);
+    /**
+     * 记录下来，以便隐藏，API editor.hidePanelOrModal
+     */
+    private record;
+    /**
+     * 除了 content 之外的其他自己要增加的 elem
+     */
+    abstract genSelfElem(): Dom7Array | null;
+    renderContent(contentElem: DOMElement): void;
+    appendTo($menuElem: Dom7Array): void;
+    show(): void;
+    hide(): void;
+}
+export default PanelAndModal;

package/dist/core/src/menus/panel-and-modal/DropPanel.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description dropPanel class
+ * @author wangfupeng
+ */
+import { IDomEditor } from '../../editor/interface';
+import { Dom7Array } from '../../utils/dom';
+import PanelAndModal from './BaseClass';
+declare class DropPanel extends PanelAndModal {
+    type: string;
+    readonly $elem: Dom7Array;
+    constructor(editor: IDomEditor);
+    genSelfElem(): Dom7Array | null;
+}
+export default DropPanel;

package/dist/core/src/menus/panel-and-modal/Modal.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @description modal class
+ * @author wangfupeng
+ */
+import { Dom7Array, DOMElement } from '../../utils/dom';
+import { IPositionStyle } from '../interface';
+import PanelAndModal from './BaseClass';
+import { IDomEditor } from '../../editor/interface';
+declare class Modal extends PanelAndModal {
+    type: string;
+    readonly $elem: Dom7Array;
+    private width;
+    constructor(editor: IDomEditor, width?: number);
+    /**
+     * 生成要添加到 modal $elem 的元素
+     * 【注意】不要直接 append 到 modal $elem ，因为它每次都会清空 html('')
+     */
+    genSelfElem(): Dom7Array | null;
+    setStyle(positionStyle: Partial<IPositionStyle>): void;
+}
+export default Modal;
+/**
+ * 生成 modal input elems
+ * @param labelText label text
+ * @param inputId input dom id
+ * @param placeholder input placeholder
+ * @returns [$container, $input]
+ */
+export declare function genModalInputElems(labelText: string, inputId: string, placeholder?: string): DOMElement[];
+/**
+ * 生成 modal textarea elems
+ * @param labelText label text
+ * @param textareaId input dom id
+ * @param placeholder input placeholder
+ * @returns [$container, $textarea]
+ */
+export declare function genModalTextareaElems(labelText: string, textareaId: string, placeholder?: string): DOMElement[];
+/**
+ * 生成 modal button elems
+ * @param buttonId button dom id
+ * @param buttonText button text
+ * @returns [ $container, $button ]
+ */
+export declare function genModalButtonElems(buttonId: string, buttonText: string): DOMElement[];

package/dist/core/src/menus/panel-and-modal/SelectList.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @description SelectList class
+ * @author wangfupeng
+ */
+import { Dom7Array } from '../../utils/dom';
+import { IOption } from '../interface';
+import PanelAndModal from './BaseClass';
+import { IDomEditor } from '../../editor/interface';
+declare class SelectList extends PanelAndModal {
+    type: string;
+    readonly $elem: Dom7Array;
+    constructor(editor: IDomEditor, width?: number);
+    /**
+     * 渲染 list
+     * @param options select options
+     */
+    renderList(options: IOption[]): void;
+    genSelfElem(): Dom7Array | null;
+}
+export default SelectList;

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

@@ -0,0 +1,16 @@
+/**
+ * @description register menu
+ * @author wangfupeng
+ */
+import { MenuFactoryType, IRegisterMenuConf } from './interface';
+export declare const MENU_ITEM_FACTORIES: {
+    [key: string]: MenuFactoryType;
+};
+/**
+ * 注册菜单配置
+ * @param registerMenuConf { key, factory, config } ，各个 menu key 不能重复
+ * @param customConfig 自定义 menu config
+ */
+export declare function registerMenu(registerMenuConf: IRegisterMenuConf, customConfig?: {
+    [key: string]: any;
+}): void;

package/dist/core/src/parse-html/helper.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @description parse-html helper fns
+ * @author wangfupeng
+ */
+/**
+ * 把 charCode 160 的空格（`&nbsp` 转换的），替换为 charCode 32 的空格（JS 默认的）
+ * @param str str
+ * @returns str
+ */
+export declare function replaceSpace160(str: string): string;

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

@@ -0,0 +1,35 @@
+/**
+ * @description parse html
+ * @author wangfupeng
+ */
+import { DOMElement } from '../utils/dom';
+import { Element as SlateElement, Descendant } from 'slate';
+import { IDomEditor } from '../editor/interface';
+export declare const TEXT_TAGS: string[];
+export type PreParseHtmlFnType = ($node: DOMElement) => DOMElement;
+export interface IPreParseHtmlConf {
+    selector: string;
+    preParseHtml: PreParseHtmlFnType;
+}
+export declare const PRE_PARSE_HTML_CONF_LIST: IPreParseHtmlConf[];
+/**
+ * 注册 pre-parse html 配置
+ * @param conf pre-parse html conf
+ */
+export declare function registerPreParseHtmlConf(conf: IPreParseHtmlConf): void;
+export type ParseStyleHtmlFnType = ($node: DOMElement, node: Descendant, editor: IDomEditor) => Descendant;
+export declare const PARSE_STYLE_HTML_FN_LIST: ParseStyleHtmlFnType[];
+/**
+ * 注册 parseStyleHtml 函数
+ * @param fn parse style html 的函数
+ */
+export declare function registerParseStyleHtmlHandler(fn: ParseStyleHtmlFnType): void;
+export type ParseElemHtmlFnType = ($elem: DOMElement, children: Descendant[], editor: IDomEditor) => SlateElement | SlateElement[];
+export declare const PARSE_ELEM_HTML_CONF: {
+    [key: string]: ParseElemHtmlFnType;
+};
+export interface IParseElemHtmlConf {
+    selector: string;
+    parseElemHtml: ParseElemHtmlFnType;
+}
+export declare function registerParseElemHtmlConf(conf: IParseElemHtmlConf): void;

package/dist/core/src/parse-html/parse-common-elem-html.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description parse elem html
+ * @author wangfupeng
+ */
+import { Dom7Array } from 'dom7';
+import { Element } from 'slate';
+import { IDomEditor } from '../editor/interface';
+/**
+ * 处理普通 DOM elem html ，非 span font 等文本 elem
+ * @param $elem $elem
+ * @param editor editor
+ * @returns slate element
+ */
+declare function parseCommonElemHtml($elem: Dom7Array, editor: IDomEditor): Element[];
+export default parseCommonElemHtml;

package/dist/core/src/parse-html/parse-elem-html.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description parse node html
+ * @author wangfupeng
+ */
+import { Dom7Array } from 'dom7';
+import { Descendant } from 'slate';
+import { IDomEditor } from '../editor/interface';
+/**
+ * 处理 DOM Elem html
+ * @param $elem $elem
+ * @param editor editor
+ * @returns slate Descendant
+ */
+declare function parseElemHtml($elem: Dom7Array, editor: IDomEditor): Descendant | Descendant[];
+export default parseElemHtml;

package/dist/core/src/parse-html/parse-text-elem-html.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description parse text html
+ * @author wangfupeng
+ */
+import { Dom7Array } from 'dom7';
+import { Text } from 'slate';
+import { IDomEditor } from '../editor/interface';
+/**
+ * 处理 text elem ，如 <span> <strong> <em> 等（并不是 DOM Text Node）
+ * @param $text $text
+ * @param editor editor
+ * @returns slate text
+ */
+declare function parseTextElemHtml($text: Dom7Array, editor: IDomEditor): Text;
+export default parseTextElemHtml;

package/dist/core/src/render/element/getRenderElem.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description 获取 elem render 函数
+ * @author wangfupeng
+ */
+import { RenderElemFnType } from '../index';
+/**
+ * 根据 elemNode.type 获取 renderElement 函数
+ * @param type elemNode.type
+ */
+declare function getRenderElem(type: string): RenderElemFnType;
+export default getRenderElem;

package/dist/core/src/render/element/renderElement.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description render element node
+ * @author wangfupeng
+ */
+import { Element as SlateElement } from 'slate';
+import { VNode } from 'snabbdom';
+import { IDomEditor } from '../../editor/interface';
+declare function renderElement(elemNode: SlateElement, editor: IDomEditor): VNode;
+export default renderElement;

package/dist/core/src/render/element/renderStyle.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @description 添加文本相关的样式
+ * @author wangfupeng
+ */
+import { Element as SlateElement } from 'slate';
+import { VNode } from 'snabbdom';
+/**
+ * 渲染样式
+ * @param elem slate elem node
+ * @param vnode elem Vnode
+ */
+declare function renderStyle(elem: SlateElement, vnode: VNode): VNode;
+export default renderStyle;

package/dist/core/src/render/helper.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @description formats helper
+ * @author wangfupeng
+ */
+export declare function genElemId(id: string): string;
+export declare function genTextId(id: string): string;

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

@@ -0,0 +1,27 @@
+/**
+ * @description formats entry
+ * @author wangfupeng
+ */
+import { Element as SlateElement, Descendant } from 'slate';
+import { VNode } from 'snabbdom';
+import { IDomEditor } from '../editor/interface';
+export type RenderStyleFnType = (node: Descendant, vnode: VNode) => VNode;
+export declare const RENDER_STYLE_HANDLER_LIST: RenderStyleFnType[];
+/**
+ * 注册处理文本样式的函数
+ * @param fn 处理文本样式的函数
+ */
+export declare function registerStyleHandler(fn: RenderStyleFnType): void;
+export type RenderElemFnType = (elemNode: SlateElement, children: VNode[] | null, editor: IDomEditor) => VNode;
+export declare const RENDER_ELEM_CONF: {
+    [key: string]: RenderElemFnType;
+};
+export interface IRenderElemConf {
+    type: string;
+    renderElem: RenderElemFnType;
+}
+/**
+ * 注册 render elem 函数
+ * @param conf { type, renderElem } ，type 即 node.type
+ */
+export declare function registerRenderElemConf(conf: IRenderElemConf): void;

package/dist/core/src/render/node2Vnode.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description slate node to vnode
+ * @author wangfupeng
+ */
+import { Node, Ancestor } from 'slate';
+import { VNode } from 'snabbdom';
+import { IDomEditor } from '../editor/interface';
+/**
+ * 根据 slate node 生成 snabbdom vnode
+ * @param node node
+ * @param index node index in parent.children
+ * @param parent parent node
+ * @param editor editor
+ */
+export declare function node2Vnode(node: Node, index: number, parent: Ancestor, editor: IDomEditor): VNode;

package/dist/core/src/render/text/genVnode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description 生成 text vnode
+ * @author wangfupeng
+ */
+import { Text as SlateText, Ancestor } from 'slate';
+import { VNode } from 'snabbdom';
+import { IDomEditor } from '../../editor/interface';
+declare function genTextVnode(leafNode: SlateText, isLast: boolean | undefined, textNode: SlateText, parent: Ancestor, editor: IDomEditor): VNode;
+export default genTextVnode;

package/dist/core/src/render/text/renderStyle.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @description text 样式
+ * @author wangfupeng
+ */
+import { Text as SlateText } from 'slate';
+import { VNode } from 'snabbdom';
+/**
+ * 给字符串增加样式
+ * @param leafNode slate text leaf node
+ * @param textVnode textVnode
+ */
+declare function addTextVnodeStyle(leafNode: SlateText, textVnode: VNode): VNode;
+export default addTextVnodeStyle;