@opentiny/fluent-editor 4.0.0-alpha.13 → 4.0.0-alpha.15

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

@@ -1,125 +1,125 @@
-export declare const ZH_CN: {
-    header: string;
-    normal: string;
-    h1: string;
-    h2: string;
-    h3: string;
-    h4: string;
-    h5: string;
-    h6: string;
-    'line-height': 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;
-    '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;
-    'mind-map': string;
-    'flow-chart': string;
-    link: string;
-    divider: string;
-    code: string;
-    table: string;
-    'table-up': string;
-    'code-block': string;
-    formula: string;
-    'format-painter': string;
-    video: string;
-    color: string;
-    background: string;
-    font: string;
-    size: string;
-    list: 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;
-    '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;
-};
+export declare const ZH_CN: {
+    header: string;
+    normal: string;
+    h1: string;
+    h2: string;
+    h3: string;
+    h4: string;
+    h5: string;
+    h6: string;
+    'line-height': 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;
+    '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;
+    'mind-map': string;
+    'flow-chart': string;
+    link: string;
+    divider: string;
+    code: string;
+    table: string;
+    'table-up': string;
+    'code-block': string;
+    formula: string;
+    'format-painter': string;
+    video: string;
+    color: string;
+    background: string;
+    font: string;
+    size: string;
+    list: 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;
+    '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,7 +1,7 @@
-export * from './editor.config';
-export * from './editor.utils';
-export * from './types';
-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";
+export * from './editor.config';
+export * from './editor.utils';
+export * from './types';
+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/additional-toolbar-item.interface.d.ts

@@ -0,0 +1,8 @@
+import { AnyFunction } from './type';
+
+export interface IAdditionalToolItemData {
+    name: string;
+    content: string;
+    icon: string;
+    handler: AnyFunction;
+}

package/types/config/types/content-change.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IContentChange {
+    content: any;
+    delta: any;
+    editor: any;
+    html: string | null;
+    oldDelta: any;
+    source: string;
+    text: string;
+    textCount: number;
+    wordCount: number;
+    htmlCount: number;
+    isChanged?: boolean;
+}

package/types/config/types/content-save.interface.d.ts

@@ -0,0 +1,6 @@
+export interface IContentSave {
+    editor: any;
+    content: any;
+    html: string | null;
+    text: string;
+}

package/types/config/types/counter-option.interface.d.ts

@@ -0,0 +1,9 @@
+import { AnyFunction } from './type';
+
+export interface ICounterOption {
+    format?: 'text' | 'html';
+    unit?: 'word' | 'char';
+    count?: number;
+    template?: string | AnyFunction;
+    errorTemplate?: string | AnyFunction;
+}

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

@@ -1,14 +1,15 @@
 import { QuillOptions } from 'quill';
 import { ScreenShotOptions } from '../../tools/screenshot';
 import { IEditorModules } from './editor-modules.interface';
-export interface IEditorConfig extends QuillOptions {
-    'modules'?: IEditorModules;
-    'screenshotOnStaticPage'?: boolean;
-    'scrollingContainer'?: HTMLElement | string | null;
-    'autoProtocol'?: boolean | string;
-    'editorPaste'?: any;
-    'screenshot'?: Partial<ScreenShotOptions>;
-    'format-painter'?: {
-        ignoreFormat?: string[];
-    };
-}
+
+export interface IEditorConfig extends QuillOptions {
+    'modules'?: IEditorModules;
+    'screenshotOnStaticPage'?: boolean;
+    'scrollingContainer'?: HTMLElement | string | null;
+    'autoProtocol'?: boolean | string;
+    'editorPaste'?: any;
+    'screenshot'?: Partial<ScreenShotOptions>;
+    'format-painter'?: {
+        ignoreFormat?: string[];
+    };
+}

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

@@ -5,41 +5,42 @@ import { FileUploaderOptions } from '../../modules/custom-uploader';
 import { EmojiModuleOptions } from '../../modules/emoji';
 import { FlowChartOptions } from '../../modules/flow-chart/options';
 import { MindMapOptions } from '../../modules/mind-map/options';
-export type ToolbarOptions = {
-    container?: HTMLElement | (Record<string, any>[] | string[] | (string | Record<string, any>)[])[];
-} & ToolbarProps;
-export interface IEditorModules {
-    [key: string]: any;
-    'clipboard'?: {
-        matchers?: any[];
-        matchVisual?: boolean;
-    } | boolean;
-    'history'?: {
-        delay?: number;
-        maxStack?: number;
-        userOnly?: boolean;
-    } | boolean;
-    'keyboard'?: {
-        bindings?: any;
-    } | boolean;
-    'syntax'?: {
-        interval?: number;
-        languages?: {
-            key: string;
-            label: string;
-        }[];
-        hljs?: any;
-    } | boolean;
-    'toolbar'?: boolean | ToolbarOptions | ToolbarOptions['container'] | string[];
-    'uploader'?: boolean | Partial<FileUploaderOptions>;
-    'shortcut-key'?: boolean | Partial<ShortCutKeyInputOptions>;
-    'mention'?: boolean | MentionOption;
-    'i18n'?: boolean | Partial<I18NOptions>;
-    'counter'?: boolean | ICounterOption;
-    'emoji'?: boolean | EmojiModuleOptions;
-    'file'?: boolean;
-    'mathlive'?: boolean;
-    'image'?: boolean | Partial<BlotFormatterOptionsInput>;
-    'mind-map'?: boolean | Partial<MindMapOptions>;
-    'flow-chart'?: boolean | Partial<FlowChartOptions>;
-}
+
+export type ToolbarOptions = {
+    container?: HTMLElement | (Record<string, any>[] | string[] | (string | Record<string, any>)[])[];
+} & ToolbarProps;
+export interface IEditorModules {
+    [key: string]: any;
+    'clipboard'?: {
+        matchers?: any[];
+        matchVisual?: boolean;
+    } | boolean;
+    'history'?: {
+        delay?: number;
+        maxStack?: number;
+        userOnly?: boolean;
+    } | boolean;
+    'keyboard'?: {
+        bindings?: any;
+    } | boolean;
+    'syntax'?: {
+        interval?: number;
+        languages?: {
+            key: string;
+            label: string;
+        }[];
+        hljs?: any;
+    } | boolean;
+    'toolbar'?: boolean | ToolbarOptions | ToolbarOptions['container'] | string[];
+    'uploader'?: boolean | Partial<FileUploaderOptions>;
+    'shortcut-key'?: boolean | Partial<ShortCutKeyInputOptions>;
+    'mention'?: boolean | MentionOption;
+    'i18n'?: boolean | Partial<I18NOptions>;
+    'counter'?: boolean | ICounterOption;
+    'emoji'?: boolean | EmojiModuleOptions;
+    'file'?: boolean;
+    'mathlive'?: boolean;
+    'image'?: boolean | Partial<BlotFormatterOptionsInput>;
+    'mind-map'?: boolean | Partial<MindMapOptions>;
+    'flow-chart'?: boolean | Partial<FlowChartOptions>;
+}

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

@@ -0,0 +1,6 @@
+import { default as Toolbar } from 'quill/modules/toolbar';
+import { default as FluentEditor } from '../../fluent-editor';
+
+export interface FluentEditorToolbar extends Toolbar {
+    quill: FluentEditor;
+}

package/types/config/types/file-operation.interface.d.ts

@@ -0,0 +1,12 @@
+import { AnyFunction } from './type';
+
+export interface FileOperation {
+    operation: string;
+    hasRejectedFile?: boolean;
+    data: {
+        fileId?: string;
+        file?: File;
+        files?: Array<File>;
+    };
+    callback?: AnyFunction;
+}

package/types/config/types/focus-change.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IFocusChange {
+    editor: any;
+    source: string;
+}

package/types/config/types/fullscreen-module.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IFullscreenModule {
+    mode?: 'normal' | 'immersive';
+    zIndex: number;
+}

package/types/config/types/help-panel-item.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IHelpPanelItem {
+    icon: string;
+    text: string;
+    hotkey: string[];
+}

package/types/config/types/help-panel-option.interface.d.ts

@@ -0,0 +1,7 @@
+import { IHelpPanelItem } from './help-panel-item.interface';
+
+export interface IHelpPanelOption {
+    id: string;
+    title: string;
+    content: IHelpPanelItem[];
+}

package/types/config/types/image-module.interface.d.ts

@@ -0,0 +1,3 @@
+export interface ImageModule {
+    zIndex: number;
+}

package/types/config/types/image-upload.interface.d.ts

@@ -0,0 +1,7 @@
+import { AnyFunction } from './type';
+
+export interface ImageUpload {
+    file: File;
+    hasRejectedImage?: boolean;
+    callback: AnyFunction;
+}

package/types/config/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from './editor-config.interface';
-export * from './editor-modules.interface';
-export * from './type';
+export * from './editor-config.interface';
+export * from './editor-modules.interface';
+export * from './type';

package/types/config/types/load-on-demand-module.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ILoadOnDemandModule {
+    mode?: 'line' | 'text';
+    limit?: number;
+    lazy?: boolean;
+}

package/types/config/types/mention-module.interface.d.ts

@@ -0,0 +1,8 @@
+export interface IMentionModule {
+    data: object[];
+    itemKey: string;
+    searchKey: string;
+    mentionSearchFn?: (term: string) => Promise<any[]>;
+    mentionSelect?: any;
+    mentionRemove?: any;
+}

package/types/config/types/paste-change.interface.d.ts

@@ -0,0 +1,6 @@
+import { AnyFunction } from './type';
+
+export interface IPasteChange {
+    files: File[];
+    callback: AnyFunction;
+}

package/types/config/types/quick-menu-module.interface.d.ts

@@ -0,0 +1,3 @@
+export interface IQuickMenuModule {
+    zIndex: number;
+}

package/types/config/types/range.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IRange {
+    index: number;
+    length: number;
+}

package/types/config/types/registry-options.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IRegistryOption {
+    importUrl?: string;
+    params?: any;
+    register?: any;
+}

package/types/config/types/selection-change.interface.d.ts

@@ -0,0 +1,8 @@
+import { IRange } from './range.interface';
+
+export interface ISelectionChange {
+    editor: any;
+    oldRange: IRange | null;
+    range: IRange | null;
+    source: string;
+}

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

@@ -0,0 +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[];
+}

package/types/config/types/type.d.ts

@@ -1,2 +1,2 @@
-export type AnyFunction = (...args: any[]) => any;
-export type Constructor<T = any, U extends Array<any> = any[]> = new (...args: U) => T;
+export type AnyFunction = (...args: any[]) => any;
+export type Constructor<T = any, U extends Array<any> = any[]> = new (...args: U) => T;

package/types/config/types/validate-error.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IValidateError {
+    minLengthError?: {
+        given: number;
+        minLength: number;
+    };
+    maxLengthError?: {
+        given: number;
+        maxLength: number;
+    };
+    requiredError?: {
+        empty: boolean;
+    };
+}

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

@@ -1,13 +1,14 @@
 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): string;
-}
-export default FluentEditor;
+
+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): string;
+}
+export default FluentEditor;

package/types/fluent-editor.d.ts

@@ -1,2 +1,3 @@
 import { default as FluentEditor } from './core/fluent-editor';
-export default FluentEditor;
+
+export default FluentEditor;

package/types/formats/emoji.d.ts

@@ -1,8 +1,9 @@
 import { default as TypeInline } from 'quill/blots/inline';
-declare const Inline: typeof TypeInline;
-export declare class EmojiBlot extends Inline {
-    static blotName: string;
-    static tagName: string;
-    static className: string;
-}
-export {};
+
+declare const Inline: typeof TypeInline;
+export declare class EmojiBlot extends Inline {
+    static blotName: string;
+    static tagName: string;
+    static className: string;
+}
+export {};

package/types/formats/index.d.ts

@@ -1,4 +1,4 @@
-export * from './emoji';
-export * from './soft-break';
-export * from './strike';
-export * from './video';
+export * from './emoji';
+export * from './soft-break';
+export * from './strike';
+export * from './video';