@opentiny/fluent-editor 3.25.4 → 4.0.0-alpha.1

package/types/attributors/font-style.d.ts

@@ -1 +1 @@
-export declare const FontStyle: import('parchment').ClassAttributor;
+export declare const FontStyle: import('parchment').StyleAttributor;

package/types/config/editor.config.d.ts

@@ -1,222 +1,4 @@
 export declare const BIG_DELTA_LIMIT = 2000;
-export declare const LANG_CONF: {
-    'en-US': {
-        header: string;
-        normal: string;
-        h1: string;
-        h2: string;
-        h3: string;
-        h4: string;
-        h5: string;
-        h6: string;
-        lineheight: string;
-        songti: string;
-        yahei: string;
-        kaiti: string;
-        heiti: string;
-        lishu: string;
-        left: string;
-        center: string;
-        right: string;
-        codeblock: string;
-        globallink: string;
-        'exit-fullscreen': string;
-        help: string;
-        more: string;
-        'help-format': string;
-        'help-insert': string;
-        'help-operation': string;
-        mention: string;
-        'quick-menu': string;
-        'toggle-help-panel': string;
-        'scroll-table': string;
-        'mouse-wheel': string;
-        save: string;
-        'copy-cells': string;
-        'copy-table': string;
-        'cut-cells': string;
-        'empty-cells': string;
-        'insert-row-up': string;
-        'insert-row-down': string;
-        'insert-column-left': string;
-        'insert-column-right': string;
-        'merge-cells': string;
-        'unmerge-cells': string;
-        'delete-row': string;
-        'delete-column': string;
-        'delete-table': string;
-        'default-link-text': string;
-        basicblock: string;
-        linkplaceholder: string;
-        'counter-template': string;
-        char: string;
-        word: string;
-        'counter-limit-tips': string;
-        'ie-msg': string;
-        loading: string;
-        pasting: string;
-        'img-error': string;
-        'img-error-info': string;
-        'last-modified': string;
-        screenshot: string;
-        uploading: string;
-        'sub-title-bg-color': string;
-        emoji: string;
-        fullscreen: string;
-        blockquote: string;
-        undo: string;
-        redo: string;
-        clean: string;
-        bold: string;
-        italic: string;
-        underline: string;
-        strike: string;
-        image: string;
-        file: string;
-        table: string;
-        link: string;
-        code: string;
-        'better-table': string;
-        'code-block': string;
-        formula: string;
-        'format-painter': string;
-        divider: string;
-        video: string;
-        color: string;
-        background: string;
-        font: string;
-        size: string;
-        'list-ordered': string;
-        'list-bullet': string;
-        'list-check': string;
-        'align-left': string;
-        'align-center': string;
-        'align-right': string;
-        'align-justify': string;
-        'direction-ltr': string;
-        'direction-rtl': string;
-        'indent--1': string;
-        'indent-+1': string;
-        'script-super': string;
-        'script-sub': string;
-        'header-normal': string;
-        'header-1': string;
-        'header-2': string;
-        'header-3': string;
-        'header-4': string;
-        'header-5': string;
-        'header-6': string;
-        'header-list': string;
-    };
-    'zh-CN': {
-        header: string;
-        normal: string;
-        h1: string;
-        h2: string;
-        h3: string;
-        h4: string;
-        h5: string;
-        h6: string;
-        lineheight: string;
-        songti: string;
-        yahei: string;
-        kaiti: string;
-        heiti: string;
-        lishu: string;
-        left: string;
-        center: string;
-        right: string;
-        codeblock: string;
-        globallink: string;
-        'exit-fullscreen': string;
-        help: string;
-        more: string;
-        'help-format': string;
-        'help-insert': string;
-        'help-operation': string;
-        mention: string;
-        'quick-menu': string;
-        'toggle-help-panel': string;
-        'scroll-table': string;
-        'mouse-wheel': string;
-        save: string;
-        'copy-cells': string;
-        'copy-table': string;
-        'cut-cells': string;
-        'empty-cells': string;
-        'insert-row-up': string;
-        'insert-row-down': string;
-        'insert-column-left': string;
-        'insert-column-right': string;
-        'merge-cells': string;
-        'unmerge-cells': string;
-        'delete-row': string;
-        'delete-column': string;
-        'delete-table': string;
-        'default-link-text': string;
-        basicblock: string;
-        linkplaceholder: string;
-        'counter-template': string;
-        char: string;
-        word: string;
-        'counter-limit-tips': string;
-        'ie-msg': string;
-        loading: string;
-        pasting: string;
-        'img-error': string;
-        'img-error-info': string;
-        'last-modified': string;
-        screenshot: string;
-        uploading: string;
-        'sub-title-bg-color': string;
-        emoji: string;
-        fullscreen: string;
-        blockquote: string;
-        undo: string;
-        redo: string;
-        clean: string;
-        bold: string;
-        italic: string;
-        underline: string;
-        strike: string;
-        image: string;
-        file: string;
-        table: string;
-        link: string;
-        divider: string;
-        code: string;
-        'better-table': string;
-        'code-block': string;
-        formula: string;
-        'format-painter': string;
-        video: string;
-        color: string;
-        background: string;
-        font: string;
-        size: string;
-        'list-ordered': string;
-        'list-bullet': string;
-        'list-check': string;
-        'align-left': string;
-        'align-center': string;
-        'align-right': string;
-        'align-justify': string;
-        'direction-ltr': string;
-        'direction-rtl': string;
-        'indent--1': string;
-        'indent-+1': string;
-        'script-super': string;
-        'script-sub': string;
-        'header-normal': string;
-        'header-1': string;
-        'header-2': string;
-        'header-3': string;
-        'header-4': string;
-        'header-5': string;
-        'header-6': string;
-        'header-list': string;
-    };
-};
 export declare const CHANGE_LANGUAGE_EVENT = "change-language";
 export declare const defaultLanguage = "en-US";
 export declare const IMAGE_UPLOADER_MIME_TYPES: string[];

package/types/config/editor.utils.d.ts

@@ -9,7 +9,6 @@ export declare function imageFileToUrl(imageFile: any): Promise<unknown>;
  * @param imageUrl 图片的URL
  */
 export declare function imageUrlToFile(imageUrl: any, isErrorImage?: boolean): Promise<unknown>;
-export declare function insideTable(range?: any, quill?: any): boolean;
 export declare function isNullOrUndefined(param: any): boolean;
 /**
  * omit

package/types/config/i18n/en-us.d.ts

@@ -7,7 +7,7 @@ export declare const EN_US: {
     h4: string;
     h5: string;
     h6: string;
-    lineheight: string;
+    'line-height': string;
     songti: string;
     yahei: string;
     kaiti: string;
@@ -30,19 +30,6 @@ export declare const EN_US: {
     'scroll-table': string;
     'mouse-wheel': string;
     save: string;
-    'copy-cells': string;
-    'copy-table': string;
-    'cut-cells': string;
-    'empty-cells': string;
-    'insert-row-up': string;
-    'insert-row-down': string;
-    'insert-column-left': string;
-    'insert-column-right': string;
-    'merge-cells': string;
-    'unmerge-cells': string;
-    'delete-row': string;
-    'delete-column': string;
-    'delete-table': string;
     'default-link-text': string;
     basicblock: string;
     linkplaceholder: string;
@@ -71,10 +58,10 @@ export declare const EN_US: {
     strike: string;
     image: string;
     file: string;
-    table: string;
     link: string;
     code: string;
-    'better-table': string;
+    table: string;
+    'table-up': string;
     'code-block': string;
     formula: string;
     'format-painter': string;
@@ -84,6 +71,7 @@ export declare const EN_US: {
     background: string;
     font: string;
     size: string;
+    list: string;
     'list-ordered': string;
     'list-bullet': string;
     'list-check': string;
@@ -105,4 +93,31 @@ export declare const EN_US: {
     'header-5': string;
     'header-6': string;
     'header-list': string;
+    'input-recall-menu-placeholder': string;
+    'clear-color': string;
+    'custom-color': string;
+    fullCheckboxText: string;
+    customBtnText: string;
+    confirmText: string;
+    cancelText: string;
+    rowText: string;
+    colText: string;
+    notPositiveNumberError: string;
+    custom: string;
+    clear: string;
+    transparent: string;
+    perWidthInsufficient: string;
+    CopyCell: string;
+    CutCell: string;
+    InsertTop: string;
+    InsertRight: string;
+    InsertBottom: string;
+    InsertLeft: string;
+    MergeCell: string;
+    SplitCell: string;
+    DeleteRow: string;
+    DeleteColumn: string;
+    DeleteTable: string;
+    BackgroundColor: string;
+    BorderColor: string;
 };

package/types/config/i18n/zh-cn.d.ts

@@ -7,7 +7,7 @@ export declare const ZH_CN: {
     h4: string;
     h5: string;
     h6: string;
-    lineheight: string;
+    'line-height': string;
     songti: string;
     yahei: string;
     kaiti: string;
@@ -30,19 +30,6 @@ export declare const ZH_CN: {
     'scroll-table': string;
     'mouse-wheel': string;
     save: string;
-    'copy-cells': string;
-    'copy-table': string;
-    'cut-cells': string;
-    'empty-cells': string;
-    'insert-row-up': string;
-    'insert-row-down': string;
-    'insert-column-left': string;
-    'insert-column-right': string;
-    'merge-cells': string;
-    'unmerge-cells': string;
-    'delete-row': string;
-    'delete-column': string;
-    'delete-table': string;
     'default-link-text': string;
     basicblock: string;
     linkplaceholder: string;
@@ -71,11 +58,11 @@ export declare const ZH_CN: {
     strike: string;
     image: string;
     file: string;
-    table: string;
     link: string;
     divider: string;
     code: string;
-    'better-table': string;
+    table: string;
+    'table-up': string;
     'code-block': string;
     formula: string;
     'format-painter': string;
@@ -84,6 +71,7 @@ export declare const ZH_CN: {
     background: string;
     font: string;
     size: string;
+    list: string;
     'list-ordered': string;
     'list-bullet': string;
     'list-check': string;
@@ -105,4 +93,31 @@ export declare const ZH_CN: {
     'header-5': string;
     'header-6': string;
     'header-list': string;
+    'input-recall-menu-placeholder': string;
+    'clear-color': string;
+    'custom-color': string;
+    fullCheckboxText: string;
+    customBtnText: string;
+    confirmText: string;
+    cancelText: string;
+    rowText: string;
+    colText: string;
+    notPositiveNumberError: string;
+    custom: string;
+    clear: string;
+    transparent: string;
+    perWidthInsufficient: string;
+    CopyCell: string;
+    CutCell: string;
+    InsertTop: string;
+    InsertRight: string;
+    InsertBottom: string;
+    InsertLeft: string;
+    MergeCell: string;
+    SplitCell: string;
+    DeleteRow: string;
+    DeleteColumn: string;
+    DeleteTable: string;
+    BackgroundColor: string;
+    BorderColor: string;
 };

package/types/config/index.d.ts

@@ -1,6 +1,6 @@
 export * from './editor.config';
 export * from './editor.utils';
-export declare function inputFile(type: any, accept: any): void;
+export declare function inputFile(type: 'image' | 'video' | 'file', accept: string[]): void;
 export declare function getListValue(value: any, preListValue: any): any;
 /** css namespace */
 export declare const namespace = "fe";

package/types/config/types/editor-config.interface.d.ts

@@ -11,25 +11,6 @@ export interface IEditorConfig extends QuillOptions {
     trackChanges?: 'user' | 'all';
     autoProtocol?: boolean | string;
     editorPaste?: any;
-    uploadOption?: {
-        imageUpload?: ({ file, callback, editor }: {
-            file: any;
-            callback: any;
-            editor: any;
-        }) => void;
-        imageAccept?: Array<string>[] | string;
-        fileAccept?: Array<string>[] | string;
-        fileUpload: ({ file, callback, editor }: {
-            file: any;
-            callback: any;
-            editor: any;
-        }) => void;
-        isVideoPlay?: boolean;
-        maxSize?: number;
-        success?: (file: File) => void;
-        fail?: (file: File) => void;
-        multiple?: boolean;
-    };
     screenshot?: Partial<ScreenShotOptions>;
     i18n?: {
         lang?: string;

package/types/config/types/editor-modules.interface.d.ts

@@ -1,3 +1,4 @@
+import { FileUploaderOptions } from '../../modules/custom-uploader';
 import { ToolbarOption } from './type';
 
 export interface IEditorModules {
@@ -28,4 +29,5 @@ export interface IEditorModules {
             [key: string]: any;
         };
     } | boolean;
+    uploader?: boolean | Partial<FileUploaderOptions>;
 }

package/types/config/types/toolbar-item.interface.d.ts

@@ -1,13 +1,13 @@
 export interface IToolbarItem {
-    indent?: string;
-    list?: string;
-    direction?: string;
-    header?: number | (boolean | number)[];
-    color?: string[];
-    background?: string[];
-    align?: string[];
-    script?: string;
-    font?: string[];
-    size?: boolean[] | string[];
-    lineheight?: number[];
+    'indent'?: string;
+    'list'?: string;
+    'direction'?: string;
+    'header'?: number | (boolean | number)[];
+    'color'?: string[];
+    'background'?: string[];
+    'align'?: string[];
+    'script'?: string;
+    'font'?: string[];
+    'size'?: boolean[] | string[];
+    'line-height'?: number[];
 }

package/types/core/fluent-editor.d.ts

@@ -1,12 +1,15 @@
 import { ExpandedQuillOptions, default as Quill } from 'quill';
 import { IEditorConfig } from '../config/types';
+import { FileUploader } from '../modules/custom-uploader';
 
 declare class FluentEditor extends Quill {
     isFullscreen: boolean;
     options: IEditorConfig & ExpandedQuillOptions;
+    uploader: FileUploader;
+    static register(...args: any[]): void;
     get lang(): string;
     constructor(container: HTMLElement | string, options?: IEditorConfig);
-    getLangText(name: string): any;
+    getLangText(name: string): string;
 }
 export type { Module, Parchment as TypeParchment, } from 'quill';
 export default FluentEditor;

package/types/index.d.ts

@@ -1,5 +1,8 @@
 import { default as FluentEditor } from './fluent-editor';
 
 export * from './config';
+export { I18N } from './modules/i18n';
+export * from './modules/table-up';
 export * from './modules/toolbar/toolbar-tip';
 export default FluentEditor;
+export { generateTableUpShortKeyMenu } from 'quill-shortcut-key';

package/types/modules/counter.d.ts

@@ -9,7 +9,7 @@ export default class Counter {
     resolveOptions(options: ICounterOption): {
         format: string;
         unit: string;
-        template: any;
+        template: string;
         count: number;
     } & ICounterOption;
     renderCount: () => void;

package/types/modules/custom-clipboard.d.ts

@@ -16,7 +16,7 @@ declare class CustomClipboard extends Clipboard {
         files: any;
         rtf: any;
     }): void;
-    files2urls(files: any, placeholders: any, originalUrls: any, pastedDelta: any, imageIndexs: any): Promise<any[]>;
+    files2urls(files: File[], placeholders: any, originalUrls: any, pastedDelta: any, imageIndexs: any): Promise<unknown[]>;
     flipFilesArray(filesArr: any): any[][];
     convertHexToBase64(hexString: any): string;
     extractImageDataFromRtf(rtfData: any): any[];

package/types/modules/custom-image/image.d.ts

@@ -1,5 +1,9 @@
-declare const Embed: unknown;
-declare const Inline: unknown;
+import { default as TypeEmbed } from 'quill/blots/embed';
+
+declare const Embed: typeof TypeEmbed;
+export type ImageValue = string | {
+    src: string;
+};
 declare class CustomImage extends Embed {
     static ID_SEED: number;
     static blotName: string;
@@ -8,7 +12,7 @@ declare class CustomImage extends Embed {
     parent: any;
     scroll: any;
     next: any;
-    static create(value: any): any;
+    static create(value: ImageValue): HTMLElement;
     static formats(domNode: any): {};
     static match(url: any): boolean;
     static register(): void;
@@ -18,11 +22,4 @@ declare class CustomImage extends Embed {
     unWrap(): void;
     wrap(name: any, value: any): any;
 }
-declare class CustomImageContainer extends Inline {
-    static tagName: string;
-    static className: string;
-    static blotName: string;
-    static allowedChildren: typeof CustomImage[];
-    constructor(scroll: any, domNode: any);
-}
-export { CustomImage as default, CustomImageContainer as ImageContainerBlot };
+export { CustomImage as default };

package/types/modules/file/formats/file.d.ts

@@ -1,15 +1,19 @@
-declare const Embed: unknown;
+import { default as TypeEmbed } from 'quill/blots/embed';
+
+declare const Embed: typeof TypeEmbed;
+export interface FileValue {
+    size: number;
+    src: string;
+    title: string;
+}
 declare class File extends Embed {
     static blotName: string;
     static tagName: string;
     static className: string;
     static PROTOCOL_WHITELIST: string[];
-    statics: any;
-    domNode: any;
-    static create(value: any): any;
-    static value(domNode: any): any;
-    static formats(domNode: any): any;
-    static getFormats(domNode: any): any;
-    static sanitize(url: any): any;
+    static create(value: FileValue): HTMLAnchorElement;
+    static value(domNode: HTMLAnchorElement): Record<string, string>;
+    static getFormats(domNode: HTMLAnchorElement): Record<string, string>;
+    static sanitize(url: string): string;
 }
 export default File;

package/types/modules/file/index.d.ts

@@ -1,11 +1,11 @@
+import { default as FluentEditor } from '../../core/fluent-editor';
 import { default as FileBar } from './modules/file-bar';
 
-declare const Module: unknown;
-declare class FileModule extends Module {
-    quill: any;
+declare class FileModule {
+    quill: FluentEditor;
     fileBar: FileBar;
     static register(): void;
-    constructor(quill: any, options: any);
-    clickEvent(event: any): void;
+    constructor(quill: FluentEditor);
+    clickEvent(event: MouseEvent): void;
 }
 export default FileModule;

package/types/modules/i18n.d.ts

@@ -2,15 +2,15 @@ import { default as FluentEditor } from '../fluent-editor';
 
 interface I18NOptions {
     lang: string;
-    langText: Record<string, string>;
 }
-declare class I18N {
+export declare class I18N {
     quill: FluentEditor;
-    isFullscreen: boolean;
+    static register(inputLangs: Record<string, Record<string, string>>, isCover?: boolean): void;
+    static parserText(text: string, lang: string): string;
     options: I18NOptions;
     constructor(quill: FluentEditor, options: Partial<I18NOptions>);
     resolveLanguageOption(options: Partial<I18NOptions>): I18NOptions;
-    changeLanguage(options: Partial<I18NOptions>): void;
+    changeLanguage(options: Partial<I18NOptions>, force?: boolean): void;
 }
 export { I18NOptions };
 export default I18N;

package/types/modules/shortcut-key/index.d.ts

@@ -0,0 +1,68 @@
+import { Range, default as Quill } from 'quill';
+import { QuillShortcutKeyInputOptions, QuillShortcutKeyOptions, default as QuillShortcutKey } from 'quill-shortcut-key';
+import { Context } from 'quill/modules/keyboard';
+import { default as FluentEditor } from '../../fluent-editor';
+
+interface ShortCutKeyCustomOptions {
+    isMenuItemsAdd: boolean;
+}
+type ShortCutKeyInputOptions = QuillShortcutKeyInputOptions & ShortCutKeyCustomOptions;
+type ShortCutKeyOptions = QuillShortcutKeyOptions & ShortCutKeyCustomOptions;
+export declare class ShortCutKey extends QuillShortcutKey {
+    quill: FluentEditor;
+    options: ShortCutKeyOptions;
+    constructor(quill: FluentEditor, options: Partial<ShortCutKeyInputOptions>);
+    resolveOptions(options: Partial<ShortCutKeyInputOptions>): ShortCutKeyOptions;
+    defaultMenuList(): ({
+        type: "item";
+        name: string;
+        alias: string[];
+        icon: any;
+        title: string;
+        onClick(this: Quill, range: Range | null, _: any): void;
+        hideSearch?: undefined;
+        children?: undefined;
+    } | {
+        type: "group";
+        name: string;
+        alias: any[];
+        hideSearch: boolean;
+        icon: any;
+        title: string;
+        children: {
+            type: "item";
+            name: string;
+            alias: string[];
+            icon: any;
+            title: string;
+            onClick: (this: Quill, range: Range | null) => void;
+        }[];
+    })[];
+}
+export declare const shortKey: {
+    link: {
+        key: string;
+        shortKey: boolean;
+        handler(_: any, context: Context): void;
+    };
+    color: {
+        key: string;
+        altKey: boolean;
+        shortKey: boolean;
+        handler(): void;
+    };
+    background: {
+        key: string;
+        altKey: boolean;
+        shortKey: boolean;
+        handler(): void;
+    };
+    clean: {
+        key: string;
+        shortKey: boolean;
+        handler(this: {
+            quill: Quill;
+        }, range: Range): void;
+    };
+};
+export {};