jodit 3.20.2 → 3.20.3

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

@@ -3,32 +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
  */
-/**
- * @module plugins/fullsize
- */
 import './fullsize.less';
 declare module 'jodit/config' {
     interface Config {
-        /**
-         * Open WYSIWYG in full screen
-         * @example
-         * ```javascript
-         * var editor = Jodit.make({
-         *     fullsize: true // fullsize editor
-         * });
-         * ```
-         * @example
-         * ```javascript
-         * var editor = Jodit.make();
-         * editor.e.fire('toggleFullSize');
-         * editor.e.fire('toggleFullSize', true); // fullsize
-         * editor.e.fire('toggleFullSize', false); // usual mode
-         * ```
-         */
         fullsize: boolean;
-        /**
-         * True, after `fullsize` -  all editors elements above jodit will get `jodit_fullsize-box_true` class (z-index: 100000 !important;)
-         */
         globalFullSize: boolean;
     }
 }

package/types/plugins/fullsize/fullsize.d.ts

@@ -3,15 +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:plugins/fullsize/README.md]]
- * @packageDocumentation
- * @module plugins/fullsize
- */
 import './fullsize.less';
 import type { IViewWithToolbar } from 'jodit/types';
 import './config';
-/**
- * Process `toggleFullSize` event, and behavior - set/unset fullsize mode
- */
 export declare function fullsize(editor: IViewWithToolbar): void;

package/types/plugins/hotkeys/config.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 plugins/hotkeys
- */
 import type { IDictionary } from 'jodit/types';
 declare module 'jodit/config' {
     interface Config {

package/types/plugins/hotkeys/hotkeys.d.ts

@@ -3,24 +3,14 @@
  * 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:plugins/hotkeys/README.md]]
- * @packageDocumentation
- * @module plugins/hotkeys
- */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
 import './config';
-/**
- * Allow set hotkey for command or button
- */
 export declare class hotkeys extends Plugin {
     private onKeyPress;
     specialKeys: {
         [key: number]: string;
     };
-    /** @override */
     afterInit(editor: IJodit): void;
-    /** @override */
     beforeDestruct(jodit: IJodit): void;
 }

package/types/plugins/hr/hr.d.ts

@@ -3,10 +3,5 @@
  * 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:plugins/hr/README.md]]
- * @packageDocumentation
- * @module plugins/hr
- */
 import type { IJodit } from 'jodit/types';
 export declare function hr(editor: IJodit): void;

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

@@ -5,60 +5,11 @@
  */
 declare module 'jodit/config' {
     interface Config {
-        /**
-         * You can redefine default page
-         *
-         * @example
-         * ```javascript
-         * Jodit.make('#editor', {
-         *    iframe: true,
-         *    iframeDefaultSrc: 'http://xdsoft.net/jodit/docs/',
-         * });
-         * ```
-         */
         iframeDefaultSrc: string;
-        /**
-         * Base URL where the root directory for [[Config.iframe]] mode
-         *
-         * @example
-         * ```javascript
-         * new Jodit('#editor', {
-         *    iframe: true,
-         *    iframeBaseUrl: 'http://xdsoft.net/jodit/docs/',
-         * });
-         * ```
-         */
         iframeBaseUrl: string;
-        /**
-         * Iframe title's content
-         */
         iframeTitle: string;
-        /**
-         * Iframe's DOCTYPE
-         */
         iframeDoctype: string;
-        /**
-         * Custom style to be used inside the iframe to display content.
-         * @example
-         * ```javascript
-         * new Jodit('#editor', {
-         *    iframe: true,
-         *    iframeStyle: 'html{margin: 0px;}',
-         * })
-         * ```
-         */
         iframeStyle: string;
-        /**
-         * Custom stylesheet files to be used inside the iframe to display content.
-         *
-         * @example
-         * ```javascript
-         * new Jodit('#editor', {
-         *    iframe: true,
-         *    iframeCSSLinks: ['styles/default.css'],
-         * })
-         * ```
-         */
         iframeCSSLinks: string[];
     }
 }

package/types/plugins/iframe/iframe.d.ts

@@ -3,15 +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:plugins/iframe/README.md]]
- * @packageDocumentation
- * @module plugins/iframe
- */
 import type { IJodit } from 'jodit/types';
 import './config';
-/**
- * Iframe plugin - use `iframe` instead of DIV in editor. It can be need when you want to attach custom styles in editor
- * in backend of you system
- */
 export declare function iframe(editor: IJodit): void;

package/types/plugins/image/image.d.ts

@@ -3,10 +3,5 @@
  * 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:plugins/image/README.md]]
- * @packageDocumentation
- * @module plugins/image
- */
 import type { IJodit } from 'jodit/types';
 export declare function image(editor: IJodit): void;

package/types/plugins/image-processor/config.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 plugins/image-processor
- */
 declare module 'jodit/config' {
     interface Config {
         imageProcessor: {

package/types/plugins/image-processor/image-processor.d.ts

@@ -3,17 +3,9 @@
  * 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:plugins/image-processor/README.md]]
- * @packageDocumentation
- * @module plugins/image-processor
- */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
 import './config';
-/**
- * Change editor's size after load all images
- */
 export declare class imageProcessor extends Plugin {
     protected afterInit(jodit: IJodit): void;
     protected beforeDestruct(jodit: IJodit): void;

package/types/plugins/image-properties/config.d.ts

@@ -7,62 +7,20 @@ declare module 'jodit/config' {
     interface Config {
         image: {
             dialogWidth: number;
-            /**
-             * Open editing dialog after double click on image
-             */
             openOnDblClick: boolean;
-            /**
-             * Show edit 'src' input
-             */
             editSrc: boolean;
-            /**
-             * Show crop/resize btn
-             */
             useImageEditor: boolean;
-            /**
-             * Show edit 'title' input
-             */
             editTitle: boolean;
-            /**
-             * Show edit 'alt' input
-             */
             editAlt: boolean;
-            /**
-             * Show edit image link's options
-             */
             editLink: boolean;
-            /**
-             * Show edit image size's inputs
-             */
             editSize: boolean;
-            /**
-             * Show edit margin inputs
-             */
             editMargins: boolean;
             editBorderRadius: boolean;
-            /**
-             * Show edit classNames input
-             */
             editClass: boolean;
-            /**
-             * Show style edit input
-             */
             editStyle: boolean;
-            /**
-             * Show edit ID input
-             */
             editId: boolean;
-            /**
-             * Show Alignment selector
-             */
             editAlign: boolean;
-            /**
-             * Show preview image
-             */
             showPreview: boolean;
-            /**
-             * Select image after close dialog
-             */
             selectImageAfterClose: boolean;
         };
     }

package/types/plugins/image-properties/image-properties.d.ts

@@ -3,18 +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:plugins/image-properties/README.md]]
- * @packageDocumentation
- * @module plugins/image-properties
- */
 import './image-properties.less';
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/modules';
 import './config';
-/**
- * Show dialog with image's options
- */
 export declare class imageProperties extends Plugin {
     protected state: {
         image: HTMLImageElement;
@@ -26,47 +18,13 @@ export declare class imageProperties extends Plugin {
     protected onChangeMarginIsLocked(): void;
     protected onChangeSizeIsLocked(): void;
     private form;
-    /**
-     * Dialog for form
-     */
     private dialog;
-    /**
-     * Open dialog editing image properties
-     *
-     * @example
-     * ```javascript
-     * const editor = Jodit.makeJodit('#editor');
-     *     img = editor.createInside.element('img');
-     *
-     * img.setAttribute('src', 'images/some-image.png');
-     * editor.s.insertImage(img);
-     * // open the properties of the editing window
-     * editor.events.fire('openImageProperties', img);
-     * ```
-     */
     protected open(): void | false;
-    /**
-     * Create form for edit image properties
-     */
     private makeForm;
-    /**
-     * Set input values from image
-     */
     private updateValues;
-    /**
-     * Apply form's values to image
-     */
     private onApply;
-    /**
-     * Open image editor dialog
-     */
     private openImageEditor;
-    /**
-     * Open popup with filebrowser/uploader buttons for image
-     */
     private openImagePopup;
-    /** @override **/
     protected afterInit(editor: IJodit): void;
-    /** @override */
     protected beforeDestruct(editor: IJodit): void;
 }

package/types/plugins/image-properties/templates/form.d.ts

@@ -3,8 +3,5 @@
  * 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 plugins/image-properties
- */
 import type { IJodit } from 'jodit/types';
 export declare function form(editor: IJodit): HTMLElement;

package/types/plugins/image-properties/templates/main-tab.d.ts

@@ -3,8 +3,5 @@
  * 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 plugins/image-properties
- */
 import type { IJodit } from 'jodit/types';
 export declare function mainTab(editor: IJodit): HTMLElement;

package/types/plugins/image-properties/templates/position-tab.d.ts

@@ -3,8 +3,5 @@
  * 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 plugins/image-properties
- */
 import type { IJodit } from 'jodit/types';
 export declare function positionTab(editor: IJodit): HTMLElement;

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

@@ -5,9 +5,6 @@
  */
 declare module 'jodit/config' {
     interface Config {
-        /**
-         * The number of pixels to use for indenting the current line.
-         */
         indentMargin: number;
     }
 }

package/types/plugins/indent/helpers.d.ts

@@ -3,8 +3,4 @@
  * 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
  */
-/**
- * Get style rule key for current direction
- * @internal
- */
 export declare const getKey: (direction: string, box: HTMLElement) => 'marginLeft' | 'marginRight' | 'paddingLeft' | 'paddingRight';

package/types/plugins/indent/indent.d.ts

@@ -3,14 +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:plugins/indent/README.md]]
- * @packageDocumentation
- * @module plugins/indent
- */
 import type { IJodit } from 'jodit/types';
 import './config';
-/**
- * Indents the line containing the selection or insertion point.
- */
 export declare function indent(editor: IJodit): void;

package/types/plugins/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:plugins/README.md]]
- * @packageDocumentation
- * @module plugins
- */
 import 'jodit/plugins/about/about';
 import 'jodit/plugins/add-new-line/add-new-line';
 import 'jodit/plugins/backspace/backspace';

package/types/plugins/inline-popup/config/config.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 plugins/inline-popup
- */
 import type { IControlType, IDictionary, IJodit } from 'jodit/types';
 declare module 'jodit/config' {
     interface Config {

package/types/plugins/inline-popup/config/items/a.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * 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 { IControlType, IJodit } from 'jodit/types';
+declare const _default: (string | IControlType<IJodit | import("jodit/types").IViewBased<import("jodit/types").IViewOptions> | import("jodit/types").IFileBrowser<import("jodit/types").IFileBrowserOptions>, import("jodit/types").IToolbarButton>)[];
+export default _default;

package/types/plugins/inline-popup/config/items/cells.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * 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 { IControlType } from 'jodit/types';
+declare const _default: (string | IControlType<import("jodit/types").IJodit | import("jodit/types").IViewBased<import("jodit/types").IViewOptions> | import("jodit/types").IFileBrowser<import("jodit/types").IFileBrowserOptions>, import("jodit/types").IToolbarButton>)[];
+export default _default;

package/types/plugins/inline-popup/config/items/iframe.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * 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 { IControlType, IJodit } from 'jodit/types';
+declare const _default: (string | IControlType<IJodit | import("jodit/types").IViewBased<import("jodit/types").IViewOptions> | import("jodit/types").IFileBrowser<import("jodit/types").IFileBrowserOptions>, import("jodit/types").IToolbarButton>)[];
+export default _default;

package/types/plugins/inline-popup/config/items/img.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * 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 { IControlType, IJodit } from 'jodit/types';
+export declare const align: IControlType<IJodit>;
+declare const _default: (string | IControlType<IJodit | import("jodit/types").IViewBased<import("jodit/types").IViewOptions> | import("jodit/types").IFileBrowser<import("jodit/types").IFileBrowserOptions>, import("jodit/types").IToolbarButton>)[];
+export default _default;

package/types/plugins/inline-popup/config/items/toolbar.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * 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
+ */
+declare const _default: string[];
+export default _default;

package/types/plugins/inline-popup/inline-popup.d.ts

@@ -3,69 +3,33 @@
  * 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:plugins/inline-popup/README.md]]
- * @packageDocumentation
- * @module plugins/inline-popup
- */
 import './inline-popup.less';
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
 import './config/config';
-/**
- * Plugin for show inline popup dialog
- */
 export declare class inlinePopup extends Plugin {
     requires: string[];
     private type;
     private popup;
     private toolbar;
     private onClick;
-    /**
-     * Show inline popup with some toolbar
-     *
-     * @param type - selection, img, a etc.
-     */
     private showPopup;
     private previousTarget?;
-    /**
-     * Hide opened popup
-     */
     private hidePopup;
     protected onOutsideClick(): void;
-    /**
-     * Can show popup for this type
-     */
     private canShowPopupForType;
-    /**
-     * For some elements do not show popup
-     */
     private isExcludedTarget;
-    /** @override **/
     protected afterInit(jodit: IJodit): void;
     private snapRange;
     private onSelectionStart;
     private onSelectionEnd;
-    /**
-     * Selection change handler
-     */
     private onSelectionChange;
-    /**
-     * In not collapsed selection - only one image
-     */
     private isSelectedTarget;
-    /**
-     * Shortcut for Table module
-     */
     private get tableModule();
-    /** @override **/
     protected beforeDestruct(jodit: IJodit): void;
     private elmsList;
     private _eventsList;
     private addListenersForElements;
     private removeListenersForElements;
-    /**
-     * Show the inline WYSIWYG toolbar editor.
-     */
     private showInlineToolbar;
 }

package/types/plugins/justify/justify.d.ts

@@ -3,13 +3,5 @@
  * 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:plugins/justify/README.md]]
- * @packageDocumentation
- * @module plugins/justify
- */
 import type { IJodit } from 'jodit/types';
-/**
- * Process commands: `justifyfull`, `justifyleft`, `justifyright`, `justifycenter`
- */
 export declare function justify(editor: IJodit): void;

package/types/plugins/key-arrow-outside/key-arrow-outside.d.ts

@@ -3,16 +3,8 @@
  * 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:plugins/key-arrow-outside/README.md]]
- * @packageDocumentation
- * @module plugins/key-arrow-outside
- */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
-/**
- * Allowing to go outside of an inline element if there is no other element after that.
- */
 export declare class keyArrowOutside extends Plugin {
     protected afterInit(jodit: IJodit): void;
     protected beforeDestruct(jodit: IJodit): void;

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

@@ -5,17 +5,8 @@
  */
 declare module 'jodit/config' {
     interface Config {
-        /**
-         * limit words count
-         */
         limitWords: false | number;
-        /**
-         * limit chars count
-         */
         limitChars: false | number;
-        /**
-         * limit html chars count
-         */
         limitHTML: false;
     }
 }

package/types/plugins/limit/limit.d.ts

@@ -3,36 +3,14 @@
  * 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:plugins/limit/README.md]]
- * @packageDocumentation
- * @module plugins/limit
- */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
 import './config';
-/**
- * Plugin control for chars or words count
- */
 export declare class limit extends Plugin {
-    /** @override **/
     protected afterInit(jodit: IJodit): void;
-    /**
-     * Action should be prevented
-     */
     private shouldPreventInsertHTML;
-    /**
-     * Check if some keypress or paste should be prevented
-     */
     private checkPreventKeyPressOrPaste;
-    /**
-     * Check if some external changing should be prevented
-     */
     private checkPreventChanging;
-    /**
-     * Split text on words without technical characters
-     */
     private splitWords;
-    /** @override **/
     protected beforeDestruct(jodit: IJodit): void;
 }

package/types/plugins/line-height/config.d.ts

@@ -5,15 +5,6 @@
  */
 declare module 'jodit/config' {
     interface Config {
-        /**
-         * Default line spacing for the entire editor
-         *
-         * ```js
-         * Jodit.make('#editor', {
-         *   defaultLineHeight: 1.2
-         * })
-         * ```
-         */
         defaultLineHeight: number | null;
     }
 }