@kaitify/vue 0.0.1-beta.1

package/lib/editor/wrapper/props.d.ts

@@ -0,0 +1,133 @@
+import { LocaleType } from '../../locale';
+import { Editor, Extension, KNode, KNodeMarksType, KNodeStylesType, RuleFunctionType, Selection } from '@kaitify/core';
+import { BubblePropsType } from '../bubble';
+/**
+ * 编辑器参数类型
+ */
+export type WrapperPropsType = {
+    /**
+     * 编辑器的值
+     */
+    modelValue: string;
+    /**
+     * 编辑器是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 语言环境
+     */
+    locale?: LocaleType;
+    /**
+     * 鼠标按下时是否不显示气泡栏
+     */
+    hideBubbleOnMousedown?: boolean;
+    /**
+     * bubble气泡栏参数
+     */
+    bubbleProps?: BubblePropsType;
+    /**
+     * 是否自动聚焦
+     */
+    autofocus?: boolean;
+    /**
+     * 编辑器内容只有一个段落时的默认文本
+     */
+    placeholder?: string;
+    /**
+     * 是否深色模式
+     */
+    dark?: boolean;
+    /**
+     * 是否允许复制
+     */
+    allowCopy?: boolean;
+    /**
+     * 是否允许粘贴
+     */
+    allowPaste?: boolean;
+    /**
+     * 是否允许剪切
+     */
+    allowCut?: boolean;
+    /**
+     * 是否允许粘贴html
+     */
+    allowPasteHtml?: boolean;
+    /**
+     * 剪切板同时存在文件和html/text时，是否优先粘贴文件
+     */
+    priorityPasteFiles?: boolean;
+    /**
+     * 自定义编辑器内渲染文本节点的真实标签
+     */
+    textRenderTag?: string;
+    /**
+     * 自定义编辑内渲染默认块级节点的真实标签，即段落标签
+     */
+    blockRenderTag?: string;
+    /**
+     * 自定义编辑器内定义需要置空的标签
+     */
+    emptyRenderTags?: string[];
+    /**
+     * 自定义编辑器内额外保留的标签
+     */
+    extraKeepTags?: string[];
+    /**
+     * 自定义插件数组
+     */
+    extensions?: Extension[];
+    /**
+     * 自定义节点数组格式化规则
+     */
+    formatRules?: RuleFunctionType[];
+    /**
+     * 自定义dom转为非文本节点的后续处理
+     */
+    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 节点粘贴保留标记的自定义方法
+     */
+    pasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
+    /**
+     * 节点粘贴保留样式的自定义方法
+     */
+    pasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
+    /**
+     * 编辑器粘贴纯文本时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要进行自定义处理
+     */
+    onPasteText?: (this: Editor, text: string) => boolean | Promise<boolean>;
+    /**
+     * 编辑器粘贴html内容时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要进行自定义处理
+     */
+    onPasteHtml?: (this: Editor, nodes: KNode[], html: string) => boolean | Promise<boolean>;
+    /**
+     * 编辑器粘贴图片时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要进行自定义处理
+     */
+    onPasteImage?: (this: Editor, file: File) => boolean | Promise<boolean>;
+    /**
+     * 编辑器粘贴视频时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要进行自定义处理
+     */
+    onPasteVideo?: (this: Editor, file: File) => boolean | Promise<boolean>;
+    /**
+     * 编辑器粘贴除了图片和视频以外的文件时触发，需要自定义处理
+     */
+    onPasteFile?: (this: Editor, file: File) => void | Promise<void>;
+    /**
+     * 在删除和换行操作中块节点节点从其父节点中抽离出去成为与父节点同级的节点后触发，如果返回true则表示继续使用默认逻辑，会将该节点转为段落，返回false则不走默认逻辑，需要自定义处理
+     */
+    onDetachMentBlockFromParentCallback?: (this: Editor, node: KNode) => boolean;
+    /**
+     * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可
+     */
+    beforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+};
+/**
+ * 编辑器状态对象
+ */
+export type StateType = {
+    editor?: Editor;
+    selection?: Selection;
+    locale: LocaleType;
+    t: (key: string) => string;
+};

package/lib/editor/wrapper/render.d.ts

@@ -0,0 +1,13 @@
+import { Editor, KNodeRenderOptionType } from '@kaitify/core';
+/**
+ * 生成VNode
+ */
+export declare const createVNode: (options: KNodeRenderOptionType) => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>;
+/**
+ * 创建VNode数组
+ */
+export declare const createVNodes: (editor: Editor) => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>[];

package/lib/editor/wrapper/wrapper.vue.d.ts

@@ -0,0 +1,79 @@
+import { StateType, WrapperPropsType } from './props';
+declare function __VLS_template(): {
+    slots: {
+        before?(_: {
+            state: StateType;
+        }): any;
+        after?(_: {
+            state: StateType;
+        }): any;
+        bubble?(_: {
+            state: StateType;
+        }): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<WrapperPropsType, {
+    elRef: import('vue').Ref<HTMLElement | undefined, HTMLElement | undefined>;
+    state: import('vue').ComputedRef<StateType>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    blur: (...args: any[]) => void;
+    focus: (...args: any[]) => void;
+    keydown: (...args: any[]) => void;
+    keyup: (...args: any[]) => void;
+    "update:modelValue": (...args: any[]) => void;
+    selectionUpdate: (...args: any[]) => void;
+    insertParagraph: (...args: any[]) => void;
+    deleteComplete: (...args: any[]) => void;
+    beforeUpdateView: (...args: any[]) => void;
+    afterUpdateView: (...args: any[]) => void;
+    created: (...args: any[]) => void;
+    bubbleShow: (...args: any[]) => void;
+    bubbleShowing: (...args: any[]) => void;
+    bubbleShown: (...args: any[]) => void;
+    bubbleHide: (...args: any[]) => void;
+    bubbleHiding: (...args: any[]) => void;
+    bubbleHidden: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<WrapperPropsType> & Readonly<{
+    onBlur?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    onKeydown?: ((...args: any[]) => any) | undefined;
+    onKeyup?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onSelectionUpdate?: ((...args: any[]) => any) | undefined;
+    onInsertParagraph?: ((...args: any[]) => any) | undefined;
+    onDeleteComplete?: ((...args: any[]) => any) | undefined;
+    onBeforeUpdateView?: ((...args: any[]) => any) | undefined;
+    onAfterUpdateView?: ((...args: any[]) => any) | undefined;
+    onCreated?: ((...args: any[]) => any) | undefined;
+    onBubbleShow?: ((...args: any[]) => any) | undefined;
+    onBubbleShowing?: ((...args: any[]) => any) | undefined;
+    onBubbleShown?: ((...args: any[]) => any) | undefined;
+    onBubbleHide?: ((...args: any[]) => any) | undefined;
+    onBubbleHiding?: ((...args: any[]) => any) | undefined;
+    onBubbleHidden?: ((...args: any[]) => any) | undefined;
+}>, {
+    disabled: boolean;
+    modelValue: string;
+    locale: import('../../locale').LocaleType;
+    hideBubbleOnMousedown: boolean;
+    autofocus: boolean;
+    placeholder: string;
+    dark: boolean;
+    allowCopy: boolean;
+    allowPaste: boolean;
+    allowCut: boolean;
+    allowPasteHtml: boolean;
+    priorityPasteFiles: boolean;
+    textRenderTag: string;
+    blockRenderTag: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from '@kaitify/core';
+export * from './core/divider';
+export * from './editor/wrapper';
+export * from './editor/menu';