jodit 4.0.0-beta.41 → 4.0.0-beta.48

package/types/plugins/clean-html/clean-html.d.ts

@@ -3,21 +3,38 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/clean-html/README.md]]
+ * @packageDocumentation
+ * @module plugins/clean-html
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin/plugin";
 import "./config";
+/**
+ * Clean HTML after removeFormat and insertHorizontalRule command
+ */
 export declare class cleanHtml extends Plugin {
+    /** @override */
     buttons: Plugin['buttons'];
+    /** @override */
     protected afterInit(jodit: IJodit): void;
     private get isEditMode();
+    /**
+     * Clean HTML code on every change
+     */
     protected onChangeCleanHTML(): void;
     private currentSelectionNode;
     private walker;
     protected startWalker(): void;
     protected beforeCommand(command: string): void | false;
+    /**
+     * Event handler when manually assigning a value to the HTML editor.
+     */
     protected onBeforeSetNativeEditorValue(data: {
         value: string;
     }): boolean;
     protected onSafeHTML(sandBox: HTMLElement): void;
+    /** @override */
     protected beforeDestruct(): void;
 }

package/types/plugins/clean-html/config.d.ts

@@ -3,20 +3,93 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { HTMLTagNames, IDictionary, Nullable } from "../../types";
 declare module 'jodit/config' {
     interface Config {
         cleanHTML: {
             timeout: number;
+            /**
+             * Replace   to plain space
+             */
             replaceNBSP: boolean;
             fillEmptyParagraph: boolean;
             removeEmptyElements: boolean;
             replaceOldTags: IDictionary<HTMLTagNames> | false;
+            /**
+             * Use iframe[sandbox] to paste HTML code into the editor to check it for safety
+             * Allows you not to run scripts and handlers, but it works much slower
+             * @example
+             * ```javascript
+             * Jodit.make('#editor', {
+             * 	 cleanHTML: {
+             * 	 	 useIframeSandbox: true
+             * 	 }
+             * 	});
+             * ```
+             */
             useIframeSandbox: boolean;
+            /**
+             * Remove onError attributes
+             */
             removeOnError: boolean;
+            /**
+             * Safe href="javascript:" links
+             */
             safeJavaScriptLink: boolean;
+            /**
+             * The allowTags option defines which elements will remain in the
+             * edited text when the editor saves. You can use this limit the returned HTML.
+             * @example
+             * ```javascript
+             * const jodit = new Jodit.make('#editor', {
+             *    cleanHTML: {
+             *       cleanOnPaste: false
+             *    }
+             * });
+             * ```
+             * @example
+             * ```javascript
+             * const editor = Jodit.make('#editor', {
+             *     cleanHTML: {
+             *         allowTags: 'p,a[href],table,tr,td, img[src=1.png]' // allow only <p>,<a>,<table>,<tr>,<td>,<img> tags and
+             *         for <a> allow only `href` attribute and <img> allow only `src` attribute == '1.png'
+             *     }
+             * });
+             * editor.value = 'Sorry! <strong>Goodby</strong>\
+             * <span>mr.</span> <a style="color:red" href="http://xdsoft.net">Freeman</a>';
+             * console.log(editor.value); //Sorry! <a href="http://xdsoft.net">Freeman</a>
+             * ```
+             *
+             * @example
+             * ```javascript
+             * const editor = Jodit.make('#editor', {
+             *     cleanHTML: {
+             *         allowTags: {
+             *             p: true,
+             *             a: {
+             *                 href: true
+             *             },
+             *             table: true,
+             *             tr: true,
+             *             td: true,
+             *             img: {
+             *                 src: '1.png'
+             *             }
+             *         }
+             *     }
+             * });
+             * ```
+             */
             allowTags: false | string | IDictionary<string>;
             denyTags: false | string | IDictionary<string>;
+            /**
+             * Node filtering rules that do not need to be applied to content
+             * The full list of rules is generated dynamically from the folder
+             * https://github.com/xdan/jodit/tree/main/src/plugins/clean-html/helpers/visitor/filters
+             */
             disableCleanFilter: Nullable<Set<string>>;
         };
     }

package/types/plugins/clean-html/helpers/get-hash.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IDictionary } from "../../../types";
+/**
+ * @private
+ */
 export declare function getHash(tags: false | string | IDictionary<string>): IDictionary | false;

package/types/plugins/clean-html/helpers/index.d.ts

@@ -3,6 +3,9 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 export * from "./get-hash";
 export * from "./remove-format/remove-format-for-collapsed-selection";
 export * from "./remove-format/remove-format-for-selection";

package/types/plugins/clean-html/helpers/remove-format/remove-format-for-collapsed-selection.d.ts

@@ -3,6 +3,17 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit, Nullable } from "../../../../types";
+/**
+ * For collapsed selection move cursor outside or split inline block
+ * @private
+ */
 export declare function removeFormatForCollapsedSelection(jodit: IJodit, fake?: Node): Nullable<Text> | void;
+/**
+ * Element has inline display mode
+ * @private
+ */
 export declare function isInlineBlock(node: Nullable<Node>): node is Node;

package/types/plugins/clean-html/helpers/remove-format/remove-format-for-selection.d.ts

@@ -3,5 +3,12 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit } from "../../../../types";
+/**
+ * Remove formatting for all selected elements
+ * @private
+ */
 export declare function removeFormatForSelection(jodit: IJodit): void;

package/types/plugins/clean-html/helpers/visitor/filters/allow-attributes.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IDictionary, IJodit } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function allowAttributes(jodit: IJodit, nodeElm: Node, hadEffect: boolean, allow: IDictionary | false): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/fill-empty-paragraph.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function fillEmptyParagraph(jodit: IJodit, nodeElm: Node, hadEffect: boolean): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/index.d.ts

@@ -3,6 +3,12 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
+/**
+ * @private
+ */
 export * from "./replace-old-tags";
 export * from "./allow-attributes";
 export * from "./fill-empty-paragraph";

package/types/plugins/clean-html/helpers/visitor/filters/remove-empty-text-node.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit, Nullable } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function removeEmptyTextNode(jodit: IJodit, node: Node, hadEffect: boolean, arg: unknown, argi: unknown, currentNode: Nullable<Node>): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/remove-inv-text-nodes.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit, Nullable } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function removeInvTextNodes(jodit: IJodit, node: Node, hadEffect: boolean, arg: unknown, argi: unknown, currentNode: Nullable<Node>): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/replace-old-tags.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function replaceOldTags(jodit: IJodit, nodeElm: Node, hadEffect: boolean): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/sanitize-attributes.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function sanitizeAttributes(jodit: IJodit, nodeElm: Node, hadEffect: boolean): boolean;

package/types/plugins/clean-html/helpers/visitor/filters/try-remove-node.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IDictionary, IJodit, Nullable } from "../../../../../types";
+/**
+ * @private
+ */
 export declare function tryRemoveNode(jodit: IJodit, nodeElm: Node, hadEffect: boolean, allowTags: IDictionary | false, denyTags: IDictionary | false, currentSelectionNode: Nullable<Node>): boolean;

package/types/plugins/clean-html/helpers/visitor/visit-node-walker.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clean-html
+ */
 import type { IJodit, Nullable, IDictionary } from "../../../../types";
+/**
+ * @private
+ */
 export declare function visitNodeWalker(jodit: IJodit, nodeElm: Node, allowTags: IDictionary | false, denyTags: IDictionary | false, currentSelectionNode: Nullable<Node>): boolean;

package/types/plugins/clipboard/clipboard.d.ts

@@ -3,12 +3,22 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/clipboard/README.md]]
+ * @packageDocumentation
+ * @module plugins/clipboard
+ */
 import type { IJodit, IPlugin } from "../../types";
 import type { Plugin } from "../../core/plugin";
 import "./config";
+/**
+ * Clipboard plugin - cut and copy functionality
+ */
 export declare class clipboard implements IPlugin {
     jodit: IJodit;
+    /** @override */
     buttons: Plugin['buttons'];
     init(editor: IJodit): void;
+    /** @override */
     destruct(editor: IJodit): void;
 }

package/types/plugins/color/color.d.ts

@@ -3,6 +3,14 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/color/README.md]]
+ * @packageDocumentation
+ * @module plugins/color
+ */
 import type { IJodit } from "../../types";
 import "./config";
+/**
+ * Process commands `background` and `forecolor`
+ */
 export declare function color(editor: IJodit): void;

package/types/plugins/copy-format/copy-format.d.ts

@@ -3,5 +3,10 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/copy-format/README.md]]
+ * @packageDocumentation
+ * @module plugins/clipboard
+ */
 import type { IJodit } from "../../types";
 export declare function copyFormat(editor: IJodit): void;

package/types/plugins/debug/debug.d.ts

@@ -3,6 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/debug/README.md]]
+ * @packageDocumentation
+ * @module plugins/debug
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin";
 export declare class Debug extends Plugin {

package/types/plugins/delete/delete.d.ts

@@ -3,6 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/delete/README.md]]
+ * @packageDocumentation
+ * @module plugins/delete
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin";
 import "./interface";
@@ -10,10 +15,19 @@ export declare class deleteCommand extends Plugin {
     requires: string[];
     protected afterInit(jodit: IJodit): void;
     protected beforeDestruct(jodit: IJodit): void;
+    /**
+     * After Delete command remove extra BR
+     */
     private __afterDeleteCommand;
     private __onDeleteCommand;
     private __moveContentInLeftSibling;
+    /**
+     * If left sibling is list - return last leaf
+     */
     private __defineRightLeftBox;
+    /**
+     * Add BR in empty blocks left and right(for table cell)
+     */
     private __addBrInEmptyBlock;
     private __moveCursorInEditableSibling;
 }

package/types/plugins/delete/interface.d.ts

@@ -5,6 +5,9 @@
  */
 declare module 'jodit/types/jodit' {
     interface IJodit {
+        /**
+         * Delete plugin: Remove selected text
+         */
         execCommand(command: 'delete'): void;
     }
 }

package/types/plugins/drag-and-drop/drag-and-drop.d.ts

@@ -4,12 +4,16 @@
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 import { Plugin } from "../../core/plugin";
+/**
+ * Process drag and drop image from FileBrowser and movev image inside the editor
+ */
 export declare class dragAndDrop extends Plugin {
     private isFragmentFromEditor;
     private isCopyMode;
     private startDragPoint;
     private draggable;
     private bufferRange;
+    /** @override */
     afterInit(): void;
     private onDragStart;
     private addDragListeners;
@@ -18,5 +22,6 @@ export declare class dragAndDrop extends Plugin {
     private onDragEnd;
     private onDrop;
     private getText;
+    /** @override */
     beforeDestruct(): void;
 }

package/types/plugins/drag-and-drop-element/config.d.ts

@@ -5,6 +5,9 @@
  */
 declare module 'jodit/config' {
     interface Config {
+        /**
+         * Draggable elements
+         */
         draggableTags: string | string[];
     }
 }

package/types/plugins/drag-and-drop-element/drag-and-drop-element.d.ts

@@ -5,20 +5,46 @@
  */
 import { Plugin } from "../../core/plugin";
 import "./config";
+/**
+ * Process drag and drop image or another element inside the editor
+ */
 export declare class dragAndDropElement extends Plugin {
     private dragList;
     private draggable;
     private isCopyMode;
+    /**
+     * Shift in pixels after which we consider that the transfer of the element has begun
+     */
     private diffStep;
     private startX;
     private startY;
     private state;
+    /** @override */
     protected afterInit(): void;
+    /**
+     * Drag start handler
+     */
     private onDragStart;
+    /**
+     * Mouse move handler handler
+     */
     private onDrag;
+    /**
+     * Mouseup handler in any place
+     */
     private onDragEnd;
+    /**
+     * Mouseup handler inside editor
+     */
     private onDrop;
+    /**
+     * Add global event listener after drag start
+     */
     private addDragListeners;
+    /**
+     * Remove global event listener after drag start
+     */
     private removeDragListeners;
+    /** @override */
     protected beforeDestruct(): void;
 }

package/types/plugins/dtd/after-insert/index.d.ts

@@ -3,4 +3,8 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/dtd
+ * @internal
+ */
 export * from "./remove-extra-br";

package/types/plugins/dtd/after-insert/remove-extra-br.d.ts

@@ -3,5 +3,14 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/dtd
+ * @internal
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Checks if there is a tag in the block element after the inserted br node,
+ * if so, removes it
+ * @internal
+ */
 export declare function removeExtraBr(jodit: IJodit, node: Node): void;

package/types/plugins/dtd/before-insert/check-block-nesting.d.ts

@@ -3,5 +3,14 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/dtd
+ * @internal
+ */
 import type { IJodit, Nullable } from "../../../types";
+/**
+ * Checks whether the insertion of an element at the current location is allowed,
+ * if it is not allowed, it deletes an empty block element or moves the cursor after it
+ * @internal
+ */
 export declare function checkBlockNesting(jodit: IJodit, node: Nullable<Node>): void;

package/types/plugins/dtd/before-insert/index.d.ts

@@ -3,4 +3,8 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/dtd
+ * @internal
+ */
 export * from "./check-block-nesting";

package/types/plugins/dtd/config.d.ts

@@ -3,12 +3,24 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/dtd
+ */
 import type { IDictionary } from "../../types";
 declare module 'jodit/config' {
     interface Config {
         dtd: {
+            /**
+             * Remove extra br element inside block element after pasting
+             */
             removeExtraBr: boolean;
+            /**
+             * Check when inserting a block element if it can be inside another block element (according `blockLimits`)
+             */
             checkBlockNesting: boolean;
+            /**
+             * List of elements that contain other blocks
+             */
             blockLimits: IDictionary<1>;
         };
     }

package/types/plugins/enter/enter.d.ts

@@ -3,13 +3,24 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * [[include:plugins/enter/README.md]]
+ * @packageDocumentation
+ * @module plugins/enter
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin/plugin";
 import "./interface";
+/**
+ * One of most important core plugins. It is responsible for all the browsers to have the same effect when the Enter
+ * button is pressed. By default, it should insert the <p>
+ */
 export declare class enter extends Plugin {
+    /** @override */
     protected afterInit(editor: IJodit): void;
     protected onEnterKeyDown(event: KeyboardEvent): false | void;
     private onEnter;
     private __isEmptyListLeaf;
+    /** @override */
     beforeDestruct(editor: IJodit): void;
 }

package/types/plugins/enter/helpers/check-br.d.ts

@@ -3,5 +3,12 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/enter
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Checks the possibility and necessity of inserting a BR instead of a block
+ * @private
+ */
 export declare function checkBR(fake: Text, jodit: IJodit, shiftKeyPressed?: boolean): boolean;

package/types/plugins/enter/helpers/check-unsplittable-box.d.ts

@@ -3,5 +3,12 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/enter
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Inside quote/tables cell, etc. you can't split so just add br
+ * @private
+ */
 export declare function checkUnsplittableBox(fake: Text, jodit: IJodit, currentBox: HTMLElement): boolean;

package/types/plugins/enter/helpers/get-block-wrapper.d.ts

@@ -3,5 +3,12 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/enter
+ */
 import type { IJodit, Nullable } from "../../../types";
+/**
+ * Finds a suitable parent block container
+ * @private
+ */
 export declare function getBlockWrapper(fake: Node | null, jodit: IJodit, tagReg?: RegExp): Nullable<HTMLElement>;

package/types/plugins/enter/helpers/has-previous-block.d.ts

@@ -3,5 +3,11 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/enter
+ */
 import type { IJodit } from "../../../types";
+/**
+ * @private
+ */
 export declare function hasPreviousBlock(fake: Text, jodit: IJodit): boolean;