jodit 4.0.0-beta.40 → 4.0.0-beta.44

package/types/modules/uploader/uploader.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:modules/uploader/README.md]]
+ * @packageDocumentation
+ * @module modules/uploader
+ */
 
 import type { HandlerError, HandlerSuccess, IUploader, IUploaderOptions, IViewBased } from "../../types";
 import { ViewComponent } from "../../core/component";
@@ -10,15 +15,45 @@ import "./config";
 export declare class Uploader extends ViewComponent implements IUploader {
     readonly jodit: IViewBased;
     get j(): IViewBased;
+    /** @override */
     className(): string;
     path: string;
     source: string;
     readonly options: IUploaderOptions<IUploader>;
     get o(): this['options'];
+    /**
+     * It sets the path for uploading files
+     */
     setPath(path: string): this;
+    /**
+     * It sets the source for connector
+     */
     setSource(source: string): this;
+    /**
+     * Set the handlers Drag and Drop to `$form`
+     *
+     * @param form - Form or any Node on which you can drag and drop the file. In addition will be processed
+     * <code>&lt;input type="file" &gt;</code>
+     * @param handlerSuccess - The function be called when a successful uploading files
+     * to the server
+     * @param handlerError - The function that will be called during a failed download files a server
+     * @example
+     * ```javascript
+     * var $form = jQuery('<form><input type="text" typpe="file"></form>');
+     * jQuery('body').append($form);
+     * Jodit.editors.someidfoeditor.uploader.bind($form[0], function (files) {
+     *     var i;
+     *     for (i = 0; i < data.files.length; i += 1) {
+     *         parent.s.insertImage(data.files[i])
+     *     }
+     * });
+     * ```
+     */
     bind(form: HTMLElement, handlerSuccess?: HandlerSuccess, handlerError?: HandlerError): void;
     private attachEvents;
+    /**
+     * Upload images to a server by its URL, making it through the connector server.
+     */
     uploadRemoteImage(url: string, handlerSuccess?: HandlerSuccess, handlerError?: HandlerError): void;
     constructor(editor: IViewBased, options?: IUploaderOptions<Uploader>);
     destruct(): any;

package/types/modules/widget/color-picker/color-picker.d.ts

@@ -3,6 +3,28 @@
  * 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:modules/widget/color-picker/README.md]]
+ * @packageDocumentation
+ * @module modules/widget/color-picker
+ */
 
 import type { IJodit } from "../../../types";
+/**
+ * Build color picker
+ *
+ * @param callback - Callback 'function (color) \{\}'
+ * @param coldColor - Color value ex. #fff or rgb(123, 123, 123) or rgba(123, 123, 123, 1)
+ * @example
+ * ```javascript
+ * $tabs = TabsWidget(editor, {
+ *    'Text' : ColorPickerWidget(editor, function (color) {
+ *         box.style.color = color;
+ *     }, box.style.color),
+ *     'Background' : ColorPickerWidget(editor, function (color) {
+ *         box.style.backgroundColor = color;
+ *     }, box.style.backgroundColor),
+ * });
+ * ```
+ */
 export declare const ColorPickerWidget: (editor: IJodit, callback: (newColor: string) => void, coldColor: string) => HTMLDivElement;

package/types/modules/widget/file-selector/file-selector.d.ts

@@ -3,11 +3,52 @@
  * 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:modules/widget/file-selector/README.md]]
+ * @packageDocumentation
+ * @module modules/widget/file-selector
+ */
 import type { IFileBrowserCallBackData, IJodit } from "../../../types";
 interface ImageSelectorCallbacks {
+    /**
+     * Function that will be called when the user enters the URL of the tab image and alternative text for images
+     */
     url?: (this: IJodit, url: string, alt: string) => void;
+    /**
+     * Function that will be called when the user clicks on the file browser tab,
+     * and then choose any image in the window that opens
+     */
     filebrowser?: (data: IFileBrowserCallBackData) => void;
+    /**
+     * Function that will be called when the user selects a file or using drag and drop files to the `Upload` tab
+     */
     upload?: ((this: IJodit, data: IFileBrowserCallBackData) => void) | true;
 }
+/**
+ * Generate 3 tabs
+ * upload - Use Drag and Drop
+ * url - By specifying the image url
+ * filebrowser - After opening the file browser . In the absence of one of the parameters will be less tabs
+ *
+ * @param callbacks - Object with keys `url`, `upload` and `filebrowser`, values which are callback
+ * functions with different parameters
+ *
+ * @example
+ * ```javascript
+ * let widget = new Jodit.modules.Widget(editor);
+ *
+ * return widget.c('ImageSelector', {
+ *      url: function (url, alt) {
+ *          editor.selections.insertImage(url);
+ *      },
+ *      upload: function (images) {
+ *          editor.selections.insertImage(images[0]);
+ *      },
+ *      filebrowser: function (images) {
+ *          editor.selections.insertImage(images[0]);
+ *      }
+ * }, image);
+ * ```
+ */
 export declare const FileSelectorWidget: (editor: IJodit, callbacks: ImageSelectorCallbacks, elm: HTMLElement | null, close: () => void, isImage?: boolean) => HTMLDivElement;
 export {};

package/types/modules/widget/index.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:modules/widget/README.md]]
+ * @packageDocumentation
+ * @module modules/widget
+ */
 export * from "./color-picker/color-picker";
 export * from "./tabs/tabs";
 export * from "./file-selector/file-selector";

package/types/modules/widget/tabs/tabs.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:modules/widget/tabs/README.md]]
+ * @packageDocumentation
+ * @module modules/widget/tabs
+ */
 
 import type { IJodit } from "../../../types";
 import { UIElement } from "../../../core/ui";
@@ -11,6 +16,23 @@ export interface TabOption {
     name: string;
     content: HTMLElement | ((this: IJodit) => void) | UIElement;
 }
+/**
+ * Build tabs system
+ *
+ * @param tabs - PlainObject where 'key' will be tab's Title and `value` is tab's content
+ * @param state - You can use for this param any HTML element for remembering active tab
+ *
+ * @example
+ * ```javascript
+ * let tabs = Jodit.modules.TabsWidget(editor, [
+ *    {name: 'Images', content: '<div>Images</div>'},
+ *    {name: 'Title 2': Jodit.modules.Helpers.dom('<div>Some content</div>')},
+ *    {name: 'Color Picker': ColorPickerWidget(editor, function (color) {
+ *         box.style.color = color;
+ *     }, box.style.color)},
+ * ]);
+ * ```
+ */
 export declare const TabsWidget: (jodit: IJodit, tabs: TabOption[], state?: {
     __activeTab: string;
 }) => HTMLDivElement;

package/types/plugins/about/about.d.ts

@@ -3,4 +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
  */
+/**
+ * [[include:plugins/about/README.md]]
+ * @packageDocumentation
+ * @module plugins/about
+ */
 

package/types/plugins/add-new-line/add-new-line.d.ts

@@ -3,10 +3,18 @@
  * 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/add-new-line/README.md]]
+ * @packageDocumentation
+ * @module plugins/add-new-line
+ */
 
 import type { IJodit } from "../../types";
 import { Plugin } from "../../modules";
 import "./config";
+/**
+ * Create helper for adding new paragraph(Jodit.defaultOptions.enter tag) before iframe, table or image
+ */
 export declare class addNewLine extends Plugin {
     private line;
     private isMatchedTag;
@@ -25,5 +33,6 @@ export declare class addNewLine extends Plugin {
     private onClickLine;
     protected onDblClickEditor(e: MouseEvent): void;
     private onMouseMove;
+    /** @override */
     protected beforeDestruct(): void;
 }

package/types/plugins/add-new-line/config.d.ts

@@ -3,12 +3,34 @@
  * 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/add-new-line
+ */
 import type { HTMLTagNames } from "../../types";
 declare module 'jodit/config' {
     interface Config {
+        /**
+         * Create helper
+         */
         addNewLine: boolean;
+        /**
+         * What kind of tags it will be impact
+         */
         addNewLineTagsTriggers: HTMLTagNames[];
+        /**
+         * On dbl click on empty space of editor it add new P element
+         * @example
+         * ```js
+         * Jodit.make('#editor', {
+         *   addNewLineOnDBLClick: false // disable
+         * })
+         * ```
+         */
         addNewLineOnDBLClick: boolean;
+        /**
+         * Absolute delta between cursor position and edge(top or bottom)
+         * of element when show line
+         */
         addNewLineDeltaShow: number;
     }
 }

package/types/plugins/backspace/backspace.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/backspace/README.md]]
+ * @packageDocumentation
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin";
 import "./config";
@@ -10,6 +15,12 @@ export declare class backspace extends Plugin {
     requires: string[];
     protected afterInit(jodit: IJodit): void;
     protected beforeDestruct(jodit: IJodit): void;
+    /**
+     * Listener BackSpace or Delete button
+     */
     private onDelete;
+    /**
+     * Remove node and replace cursor position out of it
+     */
     private safeRemoveEmptyNode;
 }

package/types/plugins/backspace/cases/check-join-neighbors.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/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Check if two separate elements can be connected
+ * @private
+ */
 export declare function checkJoinNeighbors(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-join-two-lists.d.ts

@@ -3,5 +3,21 @@
  * 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/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Try join two UL elements
+ *
+ * @example
+ * ```html
+ * <ul><li>one</li></ul>|<ol><li>two</li></ol>
+ * ```
+ * Result
+ * ```html
+ * <ul><li>one|</li><li>two</li></ul>
+ * ```
+ * @private
+ */
 export declare function checkJoinTwoLists(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-not-collapsed.d.ts

@@ -3,5 +3,21 @@
  * 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/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * On Not collapsed selection - should only remove whole selected content
+ *
+ * @example
+ * ```html
+ * <p>first | stop</p><p>second | stop</p>
+ * ```
+ * result
+ * ```html
+ * <p>first | stop</p>
+ * ```
+ * @private
+ */
 export declare function checkNotCollapsed(jodit: IJodit): boolean;

package/types/plugins/backspace/cases/check-remove-char.d.ts

@@ -3,6 +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
  */
+/**
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../../types";
 import type { DeleteMode } from "../interface";
+/**
+ * Check possibility the char can be removed
+ *
+ * @example
+ * ```html
+ * te|st
+ * ```
+ * result
+ * ```html
+ * t|st
+ * ```
+ * @private
+ */
 export declare function checkRemoveChar(jodit: IJodit, fakeNode: Node, backspace: boolean, mode: DeleteMode): boolean;

package/types/plugins/backspace/cases/check-remove-content-not-editable.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/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Checks if a non-editable element can be deleted
+ * @private
+ */
 export declare function checkRemoveContentNotEditable(jodit: IJodit, fakeNode: Text, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-remove-empty-neighbor.d.ts

@@ -3,5 +3,21 @@
  * 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/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Check if it is possible to remove an empty adjacent element.
+ *
+ * @example
+ * ```html
+ * <p><br></p><p>|second stop</p>
+ * ```
+ * result
+ * ```html
+ * <p>|second stop</p>
+ * ```
+ * @private
+ */
 export declare function checkRemoveEmptyNeighbor(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-remove-empty-parent.d.ts

@@ -3,5 +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
  */
+/**
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Check if the current empty item can be removed
+ *
+ * @example
+ * ```html
+ * <p>first stop</p><p>|<br></p>
+ * ```
+ * result
+ * ```html
+ * <p>first stop|</p>
+ * ```
+ *
+ * @private
+ */
 export declare function checkRemoveEmptyParent(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-remove-unbreakable-element.d.ts

@@ -3,5 +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
  */
+/**
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Check possibility inseparable Element can be removed (img, hr etc.)
+ *
+ * @example
+ * ```html
+ * <p>first second <img>| stop</p>
+ * ```
+ * result
+ * ```html
+ * <p>first second | stop</p>
+ * ```
+ *
+ * @private
+ */
 export declare function checkRemoveUnbreakableElement(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/check-table-cell.d.ts

@@ -3,5 +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
  */
+/**
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * Inside the CELL table - nothing to do
+ *
+ * @example
+ * ```html
+ * <table><tr><td>|test</td></tr></table>
+ * ```
+ * result
+ * ```html
+ * <table><tr><td>|test</td></tr></table>
+ * ```
+ *
+ * @private
+ */
 export declare function checkTableCell(jodit: IJodit, fakeNode: Node): boolean;

package/types/plugins/backspace/cases/check-unwrap-first-list-item.d.ts

@@ -3,5 +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
  */
+/**
+ * @module plugins/backspace
+ */
 import type { IJodit } from "../../../types";
+/**
+ * For first item in list on backspace try move his content in new P
+ *
+ * @example
+ * ```html
+ * <ul><li>|first</li><li>second</li></ul>
+ * ```
+ * Result
+ * ```html
+ * <p>|first</p><ul><li>second</li></ul>
+ * ```
+ *
+ * @private
+ */
 export declare function checkUnwrapFirstListItem(jodit: IJodit, fakeNode: Node, backspace: boolean): boolean;

package/types/plugins/backspace/cases/index.d.ts

@@ -5,4 +5,7 @@
  */
 import { checkRemoveContentNotEditable } from "./check-remove-content-not-editable";
 import { checkRemoveChar } from "./check-remove-char";
+/**
+ * @private
+ */
 export declare const cases: (typeof checkRemoveContentNotEditable | typeof checkRemoveChar)[];

package/types/plugins/backspace/helpers.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/backspace
+ */
 import type { IJodit, Nullable } from "../../types";
+/**
+ * Finds the nearest neighbor that would be in the maximum nesting depth.
+ * Ie if neighbor `<DIV><SPAN>Text` then return Text node.
+ * @private
+ */
 export declare function findMostNestedNeighbor(node: Node, right: boolean, root: HTMLElement, onlyInlide?: boolean): Nullable<Node>;
+/**
+ * @private
+ */
 export declare function getMoveFilter(jodit: IJodit): (node: Node) => boolean;

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

@@ -3,20 +3,47 @@
  * 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/backspace
+ */
 export type DeleteMode = 'char' | 'word' | 'sentence';
 declare module 'jodit/types/events' {
     interface IEventEmitter {
+        /**
+         * Allows you to prepare the content before deletion or completely override the deletion logic if you return true
+         */
         on(event: 'backSpaceBeforeCases', callback: (backspace: boolean, fakeNode: Node) => void | true): this;
+        /**
+         * Emits after backspace or delete key pressed and were processed
+         */
         on(event: 'backSpaceAfterDelete', callback: (backspace: boolean, fakeNode: Node) => void): this;
     }
 }
 declare module 'jodit/types/jodit' {
     interface IJodit {
+        /**
+         * Backspace plugin: Remove next character or selected text
+         */
         execCommand(command: 'deleteButton'): void;
+        /**
+         * Backspace plugin: Remove previous character or selected text
+         */
         execCommand(command: 'backspaceButton'): void;
+        /**
+         * Backspace plugin: Remove next word or selected text
+         */
         execCommand(command: 'deleteWordButton'): void;
+        /**
+         * Backspace plugin: Remove previous word or selected text
+         */
         execCommand(command: 'backspaceWordButton'): void;
+        /**
+         * Backspace plugin: Remove next sentence or selected text
+         */
         execCommand(command: 'deleteSentenceButton'): void;
+        /**
+         * Backspace plugin: Remove previous sentence or selected text
+         */
         execCommand(command: 'backspaceSentenceButton'): void;
     }
 }

package/types/plugins/bold/bold.d.ts

@@ -3,7 +3,15 @@
  * 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/bold/README.md]]
+ * @packageDocumentation
+ * @module plugins/bold
+ */
 import type { IJodit } from "../../types";
 import "./interface";
 import "./config";
+/**
+ * Adds `bold`,` strikethrough`, `underline` and` italic` buttons to Jodit
+ */
 export declare function bold(editor: IJodit): void;

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

@@ -5,11 +5,29 @@
  */
 declare module 'jodit/types/jodit' {
     interface IJodit {
+        /**
+         * Bold plugin: Make selected text bold
+         */
         execCommand(command: 'bold'): void;
+        /**
+         * Bold plugin: Make selected text style italic
+         */
         execCommand(command: 'italic'): void;
+        /**
+         * Bold plugin: Make selected text style underline
+         */
         execCommand(command: 'underline'): void;
+        /**
+         * Bold plugin: Make selected text style strikethrough
+         */
         execCommand(command: 'strikethrough'): void;
+        /**
+         * Bold plugin: Wrap selected text in SUB tag
+         */
         execCommand(command: 'subscript'): void;
+        /**
+         * Bold plugin: Wrap selected text in SUP tag
+         */
         execCommand(command: 'superscript'): void;
     }
 }

package/types/plugins/class-span/class-span.d.ts

@@ -3,10 +3,37 @@
  * 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/class-span/README.md]]
+ * @packageDocumentation
+ * @module plugins/class-span
+ */
 import type { IJodit } from "../../types";
 import { Plugin } from "../../core/plugin";
+/**
+ * Applying some className to selected text.
+ * @example
+ * ```js
+ * const editor = Jodit.make('#editor', {
+ *	controls: {
+ *		classSpan: {
+ *			list: {
+ *				class1: 'Classe 1',
+ *				class2: 'Classe 2',
+ *				class3: 'Classe 3',
+ *				class4: 'Classe 4',
+ *				class5: 'Classe 5'
+ *			}
+ *		}
+ *	}
+ * });
+ * ```
+ */
 export declare class classSpan extends Plugin {
+    /** @override */
     buttons: Plugin['buttons'];
+    /** @override */
     protected afterInit(jodit: IJodit): void;
+    /** @override */
     protected beforeDestruct(): void;
 }