jodit 3.20.2 → 3.20.4

package/types/core/vdom/interface.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+import type { HTMLTagNames, Nullable } from 'jodit/types';
+export interface IVDomText {
+    readonly type: 'TEXT_ELEMENT';
+    readonly props: {
+        nodeValue: string;
+        children: [];
+    };
+}
+export interface IVDomElement {
+    readonly type: HTMLTagNames;
+    readonly props: {
+        children: IVDom[];
+        [key: string]: any;
+    };
+}
+export declare type IVDom = IVDomText | IVDomElement;
+export interface IFiber {
+    effectTag?: 'PLACEMENT' | 'UPDATE' | 'DELETION';
+    parent?: IFiber;
+    sibling?: IFiber;
+    child?: IFiber;
+    alternate?: IFiber;
+    dom: Nullable<Node>;
+    type: IVDom['type'];
+    props: IVDom['props'];
+}
+export interface IRangeVDom {
+    start: IVDom;
+    startOffset: number;
+    end: IVDom;
+    endOffset: number;
+}
+export interface IVDomManipulate {
+    patch(vdom: IVDom, action: (v: IVDom) => IVDom): IVDomManipulate;
+    remove(vdom: IVDom): IVDomManipulate;
+    append(vdom: IVDom, newVDom: IVDom): IVDomManipulate;
+    prepend(vdom: IVDom, newVDom: IVDom): IVDomManipulate;
+    select(vdom: IVDom, range: IRangeVDom): IVDomManipulate;
+}
+export interface IVDomRender {
+    htmlToVDom(html: string): IVDom;
+    render(vdom: IVDom, root: HTMLElement): void;
+}

package/types/core/vdom/render/index.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+import type { IVDom } from '../interface';
+export declare class VDomRender {
+    private async;
+    private commitRoot;
+    private commitWork;
+    private commitDeletion;
+    render(element: IVDom, container: Node): void;
+    private nextUnitOfWork;
+    private currentRoot;
+    private wipRoot;
+    private deletions;
+    private workLoop;
+    constructor();
+    private performUnitOfWork;
+    private __updateHostComponent;
+    private __reconcileChildren;
+    htmlToVDom(html: string): IVDom;
+}

package/types/core/vdom/v-dom-jodit.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+import './v-dom-jodit.less';
+export declare class VDomJodit {
+    private container;
+    private vdom;
+    private render;
+    set value(v: string);
+    private constructor();
+    static make(elm: HTMLInputElement): VDomJodit;
+    private preventAllInputEvents;
+}

package/types/core/view/view-with-toolbar.d.ts

@@ -3,9 +3,6 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * @module view
- */
 import './view-with-toolbar.less';
 import type { IViewWithToolbar, IToolbarCollection, IDictionary, IPluginButton, IViewOptions } from 'jodit/types';
 import { View } from './view';
@@ -13,35 +10,16 @@ export declare abstract class ViewWithToolbar extends View implements IViewWithT
     TOOLBAR: IToolbarCollection;
     readonly toolbar: this['TOOLBAR'];
     private defaultToolbarContainer;
-    /**
-     * Container for toolbar
-     */
     get toolbarContainer(): HTMLElement;
-    /**
-     * Change panel container
-     */
     setPanel(element: HTMLElement | string): void;
-    /**
-     * Helper for append toolbar in its place
-     */
     protected buildToolbar(): void;
     registeredButtons: Set<IPluginButton>;
     private groupToButtons;
     getRegisteredButtonGroups(): IDictionary<string[]>;
-    /**
-     * Register button for group
-     */
     registerButton(btn: IPluginButton): this;
-    /**
-     * Remove button from group
-     */
     unregisterButton(btn: IPluginButton): this;
-    /**
-     * Prepare toolbar items and append buttons in groups
-     */
     private beforeToolbarBuild;
     readonly isJodit: boolean;
-    /** @override **/
     protected constructor(options?: Partial<IViewOptions>, isJodit?: boolean);
     destruct(): void;
 }

package/types/core/view/view.d.ts

@@ -3,12 +3,7 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * [[include:core/view/README.md]]
- * @packageDocumentation
- * @module view
- */
-import type { IComponent, ICreate, IProgressBar, IStorage, IViewBased, IViewOptions, Nullable, IDictionary, IEventEmitter } from 'jodit/types';
+import type { IComponent, ICreate, IProgressBar, IStorage, IViewBased, IViewOptions, Nullable, IDictionary, IEventEmitter, IMessages } from 'jodit/types';
 import { Component } from 'jodit/modules';
 import { Elms, Mods } from 'jodit/core/traits';
 export interface View extends Mods, Elms {
@@ -18,33 +13,14 @@ export declare abstract class View extends Component implements IViewBased, Mods
     readonly isView: true;
     parent: Nullable<IViewBased>;
     readonly mods: IDictionary<string | boolean | null>;
-    /**
-     * ID attribute for source element, id add `{id}_editor` it's editor's id
-     */
     id: string;
-    /**
-     * All created ViewComponent inside this view
-     */
     readonly components: Set<IComponent>;
-    /**
-     * Get path for loading extra staff
-     */
     get basePath(): string;
     readonly version: string;
     static readonly esNext: boolean;
-    /**
-     * Return default timeout period in milliseconds for some debounce or throttle functions.
-     * By default, `{history.timeout}` options
-     */
     get defaultTimeout(): number;
-    /**
-     * Some extra data inside editor
-     * @see copyformat plugin
-     */
     readonly buffer: IStorage;
-    /**
-     * Container for persistent set/get value
-     */
+    readonly message: IMessages;
     readonly storage: IStorage<import("jodit/types").StorageValueType>;
     readonly create: ICreate;
     get c(): this['create'];
@@ -53,70 +29,31 @@ export declare abstract class View extends Component implements IViewBased, Mods
     set container(container: HTMLDivElement);
     readonly events: IEventEmitter;
     get e(): this['events'];
-    /**
-     * progress_bar Progress bar
-     */
     progressbar: IProgressBar;
     OPTIONS: IViewOptions;
     private __options;
     get options(): this['OPTIONS'];
     set options(options: this['OPTIONS']);
-    /**
-     * Short alias for options
-     */
     get o(): this['options'];
-    /**
-     * Internationalization method. Uses Jodit.lang object
-     */
     i18n(text: string, ...params: Array<string | number>): string;
     private __isFullSize;
     toggleFullSize(isFullSize?: boolean): void;
     private __whoLocked;
-    /**
-     * View is locked
-     */
     get isLocked(): boolean;
     isLockedNotBy: (name: string) => boolean;
-    /**
-     * Disable selecting
-     */
     lock(name?: string): boolean;
-    /**
-     * Enable selecting
-     */
     unlock(): boolean;
-    /**
-     * View is in fullSize
-     */
     get isFullSize(): boolean;
-    /**
-     * Return current version
-     */
     getVersion(): string;
     static getVersion(): string;
-    /** @override */
     protected initOptions(options?: Partial<IViewOptions>): void;
-    /**
-     * Can change ownerWindow here
-     */
     protected initOwners(): void;
-    /**
-     * Add option's event handlers in emitter
-     */
     protected attachEvents(options?: IViewOptions): void;
     protected constructor(options?: Partial<IViewOptions>, isJodit?: boolean);
     private __modulesInstances;
-    /**
-     * Make one instance of one module
-     */
     getInstance<T extends IComponent>(moduleName: string, options?: object): T;
-    /** Add some element to box */
     protected addDisclaimer(elm: HTMLElement): void;
-    /**
-     * Call before destruct
-     */
     protected beforeDestruct(): void;
-    /** @override */
     destruct(): void;
     static defaultOptions: IViewOptions;
 }

package/types/index.d.ts

@@ -3,12 +3,7 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * [[include:README.md]]
- * @packageDocumentation
- * @module jodit
- */
-import './styles';
+import './styles/index.less';
 import { Jodit as DefaultJodit } from './jodit';
 import 'jodit/plugins/index';
 export { DefaultJodit as Jodit };

package/types/jodit.d.ts

@@ -3,367 +3,115 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * [[include:README.md]]
- * @packageDocumentation
- * @module jodit
- */
 import type { CustomCommand, IDictionary, IPluginSystem, IStatusBar, IWorkPlace, Modes, IFileBrowser, IJodit, IUploader, ICreate, IStorage, CanPromise, IHistory } from './types';
+import type * as Modules from './modules/';
 import { Config } from './config';
 import * as constants from './core/constants';
-import { Plugin, Select, ViewWithToolbar } from './modules/';
+import { Select, ViewWithToolbar } from './modules/';
 import { Dlgs } from 'jodit/core/traits';
-/**
- * Class Jodit. Main class
- */
 export interface Jodit extends Dlgs {
 }
 export declare class Jodit extends ViewWithToolbar implements IJodit, Dlgs {
-    /** @override */
     className(): string;
-    /**
-     * Return promise for ready actions
-     * @example
-     * ```js
-     * const jodit = Jodit.make('#editor');
-     * await jodit.waitForReady();
-     * jodit.e.fire('someAsyncLoadedPluginEvent', (test) => {
-     *   alert(test);
-     * });
-     * ```
-     */
     waitForReady(): Promise<IJodit>;
     static get ready(): Promise<IJodit>;
-    /**
-     * Define if object is Jodit
-     */
     readonly isJodit: true;
-    /**
-     * Plain text editor's value
-     */
     get text(): string;
-    /**
-     * Return default timeout period in milliseconds for some debounce or throttle functions.
-     * By default, `{history.timeout}` options
-     */
     get defaultTimeout(): number;
-    /**
-     * Method wrap usual Has Object in Object helper for prevent deep object merging in options*
-     */
     static atom<T>(object: T): T;
-    /**
-     * Factory for creating Jodit instance
-     */
     static make(element: HTMLElement | string, options?: object): Jodit;
-    /**
-     * Checks if the element has already been initialized when for Jodit
-     */
     static isJoditAssigned(element: HTMLElement): element is HTMLElement & {
         component: Jodit;
     };
-    /**
-     * Default settings
-     */
     static get defaultOptions(): Config;
     static fatMode: boolean;
     static readonly plugins: IPluginSystem;
-    static readonly modules: IDictionary<Function>;
-    static readonly ns: IDictionary<Function>;
+    static modules: typeof Modules;
+    static ns: typeof Modules;
     static readonly decorators: IDictionary<Function>;
     static readonly constants: typeof constants;
     static readonly instances: IDictionary<IJodit>;
     static readonly lang: any;
     static readonly core: {
-        Plugin: typeof Plugin;
+        Plugin: typeof Modules.Plugin;
     };
     private readonly commands;
     private __selectionLocked;
     private __wasReadOnly;
-    /**
-     * Container for set/get value
-     */
     readonly storage: IStorage;
     readonly createInside: ICreate;
-    /**
-     * Editor has focus in this time
-     */
     editorIsActive: boolean;
     private setPlaceField;
-    /**
-     * element It contains source element
-     */
     get element(): HTMLElement;
-    /**
-     * editor It contains the root element editor
-     */
     get editor(): HTMLDivElement | HTMLBodyElement;
     set editor(editor: HTMLDivElement | HTMLBodyElement);
-    /**
-     * Container for all staff
-     */
     get container(): HTMLDivElement;
     set container(container: HTMLDivElement);
-    /**
-     * workplace It contains source and wysiwyg editors
-     */
     get workplace(): HTMLDivElement;
-    /**
-     * Statusbar module
-     */
     get statusbar(): IStatusBar;
-    /**
-     * iframe Iframe for iframe mode
-     */
     get iframe(): HTMLIFrameElement | void;
     set iframe(iframe: HTMLIFrameElement | void);
     get history(): IHistory;
-    /**
-     * @deprecated Instead use `Jodit.history`
-     */
     get observer(): IHistory;
-    /**
-     * In iframe mode editor's window can be different by owner
-     */
     get editorWindow(): Window;
     set editorWindow(win: Window);
-    /**
-     * Alias for this.ew
-     */
     get ew(): this['editorWindow'];
-    /**
-     * In iframe mode editor's window can be different by owner
-     */
     get editorDocument(): Document;
-    /**
-     * Alias for this.ew
-     */
     get ed(): this['editorDocument'];
-    /**
-     * options All Jodit settings default + second arguments of constructor
-     */
     get options(): Config;
     set options(opt: Config);
     readonly selection: Select;
-    /**
-     * Alias for this.selection
-     */
     get s(): this['selection'];
     get uploader(): IUploader;
     get filebrowser(): IFileBrowser;
     private __mode;
-    /**
-     * Editor's mode
-     */
     get mode(): Modes;
     set mode(mode: Modes);
-    /**
-     * Return real HTML value from WYSIWYG editor.
-     */
     getNativeEditorValue(): string;
-    /**
-     * Set value to native editor
-     */
     setNativeEditorValue(value: string): void;
-    /**
-     * HTML value
-     */
     get value(): string;
     set value(html: string);
     synchronizeValues(): void;
-    /**
-     * This is an internal method, do not use it in your applications.
-     * @private
-     */
     __imdSynchronizeValues(): void;
-    /**
-     * Return editor value
-     */
     getEditorValue(removeSelectionMarkers?: boolean, consumer?: string): string;
     private __callChangeCount;
-    /**
-     * Set editor html value and if set sync fill source element value
-     * When method was called without arguments - it is simple way to synchronize editor to element
-     */
     setEditorValue(value?: string): void;
-    /**
-     * If some plugin changes the DOM directly, then you need to update the content of the original element
-     */
     protected updateElementValue(): void;
-    /**
-     * Return source element value
-     */
     getElementValue(): string;
-    /**
-     * @deprecated Use `Jodit.value` instead
-     */
     protected setElementValue(value?: string): CanPromise<void>;
     private __setElementValue;
-    /**
-     * Register custom handler for command
-     *
-     * @example
-     * ```javascript
-     * var jodit = Jodit.make('#editor);
-     *
-     * jodit.setEditorValue('test test test');
-     *
-     * jodit.registerCommand('replaceString', function (command, needle, replace) {
-     *      var value = this.getEditorValue();
-     *      this.setEditorValue(value.replace(needle, replace));
-     *      return false; // stop execute native command
-     * });
-     *
-     * jodit.execCommand('replaceString', 'test', 'stop');
-     *
-     * console.log(jodit.value); // stop test test
-     *
-     * // and you can add hotkeys for command
-     * jodit.registerCommand('replaceString', {
-     *    hotkeys: 'ctrl+r',
-     *    exec: function (command, needle, replace) {
-     *     var value = this.getEditorValue();
-     *     this.setEditorValue(value.replace(needle, replace));
-     *    }
-     * });
-     *
-     * ```
-     */
     registerCommand(commandNameOriginal: string, command: CustomCommand<IJodit>, options?: {
         stopPropagation: boolean;
     }): IJodit;
-    /**
-     * Register hotkey for command
-     */
     registerHotkeyToCommand(hotkeys: string | string[], commandName: string, shouldStop?: boolean): void;
-    /**
-     * Execute command editor
-     *
-     * @param command - command. It supports all the
-     * @see https://developer.mozilla.org/ru/docs/Web/API/Document/execCommand#commands and a number of its own
-     * for example applyStyleProperty. Comand fontSize receives the second parameter px,
-     * formatBlock and can take several options
-     * @example
-     * ```javascript
-     * this.execCommand('fontSize', 12); // sets the size of 12 px
-     * this.execCommand('underline');
-     * this.execCommand('formatBlock', 'p'); // will be inserted paragraph
-     * ```
-     */
     execCommand(command: string, showUI?: boolean, value?: null | any): void;
-    /**
-     * Don't raise a change event
-     */
     private isSilentChange;
-    /**
-     * Exec native command
-     */
     nativeExecCommand(command: string, showUI?: boolean, value?: null | any): boolean;
     private execCustomCommands;
-    /**
-     * Disable selecting
-     */
     lock(name?: string): boolean;
-    /**
-     * Enable selecting
-     */
     unlock(): boolean;
-    /**
-     * Return current editor mode: Jodit.MODE_WYSIWYG, Jodit.MODE_SOURCE or Jodit.MODE_SPLIT
-     */
     getMode(): Modes;
     isEditorMode(): boolean;
-    /**
-     * Return current real work mode. When editor in MODE_SOURCE or MODE_WYSIWYG it will
-     * return them, but then editor in MODE_SPLIT it will return MODE_SOURCE if
-     * Textarea(CodeMirror) focused or MODE_WYSIWYG otherwise
-     *
-     * @example
-     * ```javascript
-     * var editor = Jodit.make('#editor');
-     * console.log(editor.getRealMode());
-     * ```
-     */
     getRealMode(): Modes;
-    /**
-     * Set current mode
-     */
     setMode(mode: number | string): void;
-    /**
-     * Toggle editor mode WYSIWYG to TEXTAREA(CodeMirror) to SPLIT(WYSIWYG and TEXTAREA) to again WYSIWYG
-     *
-     * @example
-     * ```javascript
-     * var editor = Jodit.make('#editor');
-     * editor.toggleMode();
-     * ```
-     */
     toggleMode(): void;
-    /**
-     * Switch on/off the editor into the disabled state.
-     * When in disabled, the user is not able to change the editor content
-     * This function firing the `disabled` event.
-     */
     setDisabled(isDisabled: boolean): void;
-    /**
-     * Return true if editor in disabled mode
-     */
     getDisabled(): boolean;
-    /**
-     * Switch on/off the editor into the read-only state.
-     * When in readonly, the user is not able to change the editor content, but can still
-     * use some editor functions (show source code, print content, or seach).
-     * This function firing the `readonly` event.
-     */
     setReadOnly(isReadOnly: boolean): void;
-    /**
-     * Return true if editor in read-only mode
-     */
     getReadOnly(): boolean;
-    /**
-     * Hook before init
-     */
     beforeInitHook(): CanPromise<void>;
-    /**
-     * Hook after init
-     */
     afterInitHook(): void;
-    /** @override **/
     protected initOptions(options?: object): void;
-    /** @override **/
     protected initOwners(): void;
-    /**
-     * Create instance of Jodit
-     *
-     * @param element - Selector or HTMLElement
-     * @param options - Editor's options
-     *
-     * @deprecated - Instead use `Jodit.make`
-     */
     constructor(element: HTMLElement | string, options?: object);
     currentPlace: IWorkPlace;
     places: IWorkPlace[];
     private readonly elementToPlace;
-    /**
-     * Create and init current editable place
-     */
     addPlace(source: HTMLElement | string, options?: object): void | Promise<any>;
-    /** @override */
     protected addDisclaimer(elm: HTMLElement): void;
-    /**
-     * Set current place object
-     */
     setCurrentPlace(place: IWorkPlace): void;
     private initEditor;
-    /**
-     * Create main DIV element and replace source textarea
-     */
     private createEditor;
-    /**
-     * Attach some native event listeners
-     */
     private prepareWYSIWYGEditor;
-    /**
-     * Jodit's Destructor. Remove editor, and return source input
-     */
     destruct(): void;
 }

package/types/langs/index.d.ts

@@ -3,11 +3,6 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * [[include:langs/README.md]]
- * @packageDocumentation
- * @module langs
- */
 import type { IDictionary } from 'jodit/types';
 declare let exp: IDictionary<IDictionary<string>>;
 export default exp;

package/types/modules/context-menu/context-menu.d.ts

@@ -3,30 +3,10 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- * [[include:modules/context-menu/README.md]]
- * @packageDocumentation
- * @module modules/context-menu
- */
 import './context-menu.less';
 import type { IContextMenu, IContextMenuAction } from 'jodit/types';
 import { Popup } from 'jodit/core/ui/popup';
-/**
- * Module to generate context menu
- */
 export declare class ContextMenu extends Popup implements IContextMenu {
-    /** @override */
     className(): string;
-    /**
-     * Generate and show context menu
-     *
-     * @param x - Global coordinate by X
-     * @param y - Global coordinate by Y
-     * @param actions - Array with plain objects `{icon: 'bin', title: 'Delete', exec: function () {}}`
-     * @example
-     * ```javascript
-     * parent.show(e.clientX, e.clientY, [{icon: 'bin', title: 'Delete', exec: function () { alert(1) }]);
-     * ```
-     */
     show(x: number, y: number, actions: Array<false | IContextMenuAction>): void;
 }