jodit 3.8.4 → 3.8.8

package/types/core/events/events-native.d.ts

@@ -8,6 +8,10 @@
  */
 import type { CallbackFunction, IEventsNative } from '../../types';
 export declare class EventsNative implements IEventsNative {
+    private mutedEvents;
+    mute(event?: string): this;
+    isMuted(event?: string): boolean;
+    unmute(event?: string): this;
     readonly __key: string;
     private doc;
     private eachEvent;
@@ -34,11 +38,11 @@ export declare class EventsNative implements IEventsNative {
     /**
      * Sets the handler for the specified event ( Event List ) for a given element .
      *
-     * @param {object|string} subjectOrEvents - The object for which toWYSIWYG set an event handler
-     * @param {string|Function} eventsOrCallback - List of events , separated by a space or comma
-     * @param {function} [handlerOrSelector] - The event handler
-     * @param {selector} [selector] - Selector for capturing
-     * @param {Boolean} [onTop=false] - Set handler in first
+     * @param subjectOrEvents - The object for which toWYSIWYG set an event handler
+     * @param eventsOrCallback - List of events , separated by a space or comma
+     * @param handlerOrSelector - The event handler
+     * @param selector - Selector for capturing
+     * @param onTop - Set handler in first
      *
      * @example
      * ```javascript
@@ -62,10 +66,10 @@ export declare class EventsNative implements IEventsNative {
     /**
      * Disable all handlers specified event ( Event List ) for a given element. Either a specific event handler.
      *
-     * @param {object} subjectOrEvents - The object which is disabled handlers
-     * @param {string|Function} [eventsOrCallback] - List of events, separated by a space or comma , which is necessary
+     * @param subjectOrEvents - The object which is disabled handlers
+     * @param eventsOrCallback - List of events, separated by a space or comma , which is necessary
      * toWYSIWYG disable the handlers for a given object
-     * @param {function} [handler] - Specific event handler toWYSIWYG be removed
+     * @param handler - Specific event handler toWYSIWYG be removed
      *
      * @example
      * ```javascript
@@ -94,9 +98,6 @@ export declare class EventsNative implements IEventsNative {
     off(subject: object, events?: string, handler?: CallbackFunction): this;
     /**
      * Stop execute all another listeners for this event
-     *
-     * @param subjectOrEvents
-     * @param eventsList
      */
     stopPropagation(events: string): void;
     stopPropagation(subject: object, eventsList: string): void;
@@ -106,10 +107,10 @@ export declare class EventsNative implements IEventsNative {
     /**
      * Sets the handler for the specified event (Event List) for a given element .
      *
-     * @param {object|string} subjectOrEvents - The object which is caused by certain events
-     * @param {string|Array} eventsList - List of events , separated by a space or comma
-     * @param {Array} [args] - Options for the event handler
-     * @return {boolean} `false` if one of the handlers return `false`
+     * @param subjectOrEvents - The object which is caused by certain events
+     * @param eventsList - List of events , separated by a space or comma
+     * @param args - Options for the event handler
+     * @returns `false` if one of the handlers return `false`
      * @example
      * ```javascript
      * var dialog = new Jodit.modules.Dialog();
@@ -119,13 +120,13 @@ export declare class EventsNative implements IEventsNative {
      * dialog.open('Hello world!!!');
      * ```
      *  or you can trigger native browser listener
-     *  ```javascript
+     * ```javascript
      *  var events = new Jodit.modules.EventsNative();
      *  events.on(document.body, 'click',function (event) {
      *      alert('click on ' + event.target.id );
      *  });
      *  events.fire(document.body.querySelector('div'), 'click');
-     *  ```
+     * ```
      *
      */
     fire(subjectOrEvents: string, ...args: any[]): any;

package/types/core/events/observe-object.d.ts

@@ -13,8 +13,6 @@ export declare class ObserveObject {
     toString(): string;
     /**
      * Add listener on some changes
-     * @param event
-     * @param callback
      */
     on(event: string | string[], callback: CallbackFunction): this;
     private __lockEvent;

package/types/core/global.d.ts

@@ -17,10 +17,6 @@ export declare const lang: IDictionary<IDictionary<string>>;
 export declare const extendLang: (langs: IDictionary) => void;
 /**
  * Create unique box(HTMLCotainer) and remove it after destroy
- *
- * @param jodit
- * @param name
- * @param [tag]
  */
 export declare function getContainer<T extends HTMLTagNames = HTMLTagNames>(jodit: IViewBased | IViewComponent, classFunc: Function, tag?: T, createInsideEditor?: boolean): HTMLElementTagNameMap[T];
 /**

package/types/core/helpers/append-script.d.ts

@@ -11,11 +11,6 @@ export interface CallbackAndElement {
 }
 /**
  * Append script in document and call callback function after download
- *
- * @param url
- * @param callback
- * @param className
- * @param doc
  */
 export declare const appendScript: (jodit: IViewBased, url: string, callback: (this: HTMLElement, e?: Event | undefined) => any) => CallbackAndElement;
 /**
@@ -24,9 +19,6 @@ export declare const appendScript: (jodit: IViewBased, url: string, callback: (t
 export declare const appendScriptAsync: Loader;
 /**
  * Download CSS style script
- *
- * @param url
- * @param doc
  */
 export declare const appendStyleAsync: Loader;
 export declare const loadNext: (jodit: IViewBased, urls: string[], i?: number) => Promise<void>;

package/types/core/helpers/array/as-array.d.ts

@@ -3,4 +3,7 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * Always return Array
+ */
 export declare const asArray: <T>(a: T | T[]) => T[];

package/types/core/helpers/array/split-array.d.ts

@@ -5,7 +5,6 @@
  */
 /**
  * Split separated elements
- * @param a
  */
 export declare function splitArray(a: string): string[];
 export declare function splitArray<T extends any[]>(a: T): T;

package/types/core/helpers/async/set-timeout.d.ts

@@ -5,16 +5,9 @@
  */
 /**
  * Create async callback if set timeout value - else call function immediately
- *
- * @param callback
- * @param timeout
- * @param a1
- * @param a2
- * @param a3
  */
 export declare function setTimeout<T = any>(callback: (...args: T[]) => void, timeout: number, ...args: T[]): number;
 /**
  * Clear timeout
- * @param timer
  */
 export declare function clearTimeout(timer: number): void;

package/types/core/helpers/browser.d.ts

@@ -5,7 +5,6 @@
  */
 /**
  * Module returns method that is used to determine the browser
- * @params {Object} parent main Jodit object
  * @example
  * ```javascript
  * console.log(Jodit.modules.Helpers.browser('mse'));

package/types/core/helpers/checker/has-browser-color-picker.d.ts

@@ -5,8 +5,5 @@
  */
 /**
  * Check if browser has a color picker (a new HTML5 attribute for input tag)
- *
- * @method hasBrowserColorPicker
- * @return {boolean}
  */
 export declare function hasBrowserColorPicker(): boolean;

package/types/core/helpers/checker/is-array.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  * Check if element is array
- * @param elm
  */
 export declare function isArray<T = any>(elm: unknown): elm is T[];

package/types/core/helpers/checker/is-equal.d.ts

@@ -5,9 +5,6 @@
  */
 /**
  * Check two element are equal
- *
- * @param a
- * @param b
  */
 export declare function isEqual(a: unknown, b: unknown): boolean;
 export declare function isFastEqual(a: unknown, b: unknown): boolean;

package/types/core/helpers/checker/is-function.d.ts

@@ -5,7 +5,5 @@
  */
 /**
  * Check value is Function
- *
- * @param value
  */
 export declare function isFunction(value: unknown): value is Function;

package/types/core/helpers/checker/is-html-from-word.d.ts

@@ -5,8 +5,5 @@
  */
 /**
  * Detect if string is HTML from MS Word or Excel
- *
- * @param {string} data
- * @return {boolean}
  */
 export declare function isHtmlFromWord(data: string): boolean;

package/types/core/helpers/checker/is-html.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  * Check if a string is html or not
- ** @param str
  */
 export declare const isHTML: (str: unknown) => str is string;

package/types/core/helpers/checker/is-number.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  * Check value is a number
- * @param value
  */
 export declare function isNumber(value: unknown): value is number;

package/types/core/helpers/checker/is-numeric.d.ts

@@ -5,7 +5,5 @@
  */
 /**
  * Check value has numeric format
- *
- * @param value
  */
 export declare function isNumeric(value: number | string): boolean;

package/types/core/helpers/checker/is-plain-object.d.ts

@@ -6,6 +6,5 @@
 import type { IDictionary } from '../../../types';
 /**
  * Check if element is simple plaint object
- * @param obj
  */
 export declare function isPlainObject<T>(obj: any | IDictionary<T>): obj is IDictionary<T>;

package/types/core/helpers/checker/is-string.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  * Check value is String
- * @param value
  */
 export declare function isString(value: unknown): value is string;

package/types/core/helpers/checker/is-url.d.ts

@@ -5,9 +5,5 @@
  */
 /**
  * Check if a string is a url
- *
- * @method isURL
- * @param {string} str
- * @return {boolean}
  */
 export declare function isURL(str: string): boolean;

package/types/core/helpers/color/color-to-hex.d.ts

@@ -6,8 +6,8 @@
 /**
  * Converts rgba text representation of color in hex
  *
- * @param {string} color - string like rgba(red, green, blue, alpha) or rgb(red, green, blue)
- * @return {string | NaN} hex color view, NaN - for transparent color
+ * @param color - string like rgba(red, green, blue, alpha) or rgb(red, green, blue)
+ * @returns hex color view, NaN - for transparent color
  * @example
  * ```javascript
  * var p = document.createElement('p');

package/types/core/helpers/config-proto.d.ts

@@ -33,9 +33,6 @@ import type { IDictionary } from '../../types';
  * console.log(options.d.g); // 8
  *
  * ```
- * @param options
- * @param proto
- * @param level
  */
 export declare function ConfigProto(options: IDictionary, proto: IDictionary, deep?: number): IDictionary;
 export declare function ConfigFlatten(obj: IDictionary): IDictionary;

package/types/core/helpers/convert-media-url-to-video-embed.d.ts

@@ -4,11 +4,6 @@
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- *  Javascript url pattern converter replace youtube/vimeo url in embed code.
- *
- * @param {string} url
- * @param {int} [width=400]
- * @param {int} [height=345]
- * return {string} embed code
+ * Javascript url pattern converter replace youtube/vimeo url in embed code.
  */
 export declare const convertMediaUrlToVideoEmbed: (url: string, width?: number, height?: number) => string;

package/types/core/helpers/ctrl-key.d.ts

@@ -5,8 +5,6 @@
  */
 /**
  * CTRL pressed
- *
- * @param  {KeyboardEvent} e Event
- * @return {boolean} true ctrl key was pressed
+ * @returns true ctrl key was pressed
  */
 export declare const ctrlKey: (e: MouseEvent | KeyboardEvent) => boolean;

package/types/core/helpers/data-bind.d.ts

@@ -4,10 +4,4 @@
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 import type { IViewComponent } from '../../types';
-/**
- *
- * @param elm
- * @param key
- * @param value
- */
 export declare const dataBind: <T = any>(elm: IViewComponent | Node | object, key: string, value?: T | undefined) => T;

package/types/core/helpers/default-language.d.ts

@@ -5,8 +5,5 @@
  */
 /**
  * Try define user language
- *
- * @param language
- * @param defaultLanguage
  */
 export declare const defaultLanguage: (language?: string | undefined, defaultLanguage?: string) => string;

package/types/core/helpers/each.d.ts

@@ -5,7 +5,16 @@
  */
 import type { IDictionary } from '../../types';
 declare type eachCallback<T, N> = (this: T, key: N, value: T) => boolean | void;
+/**
+ * @deprecated Use Object.keys
+ */
 export declare function each<T>(obj: T[], callback: eachCallback<T, number>): boolean;
+/**
+ * @deprecated Use Object.keys
+ */
 export declare function each<T>(obj: IDictionary<T>, callback: eachCallback<T, string>): boolean;
+/**
+ * @deprecated Use Object.keys
+ */
 export declare function each<T>(obj: T[] | IDictionary<T>, callback: eachCallback<T, number | string>): boolean;
 export {};

package/types/core/helpers/html/htmlspecialchars.d.ts

@@ -5,9 +5,5 @@
  */
 /**
  * Convert special characters to HTML entities
- *
- * @method htmlspecialchars
- * @param {string} html
- * @return {string}
  */
 export declare function htmlspecialchars(html: string): string;

package/types/core/helpers/html/nl2br.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  *  Inserts HTML line breaks before all newlines in a string
- * @param html
  */
 export declare function nl2br(html: string): string;

package/types/core/helpers/human-size-to-bytes.d.ts

@@ -5,9 +5,6 @@
  */
 /**
  * Converts from human readable file size (kb,mb,gb,tb) to bytes
- *
- * @method humanSizeToBytes
- * @param {string|int} human readable file size. Example 1gb or 11.2mb
- * @return {int}
+ * @param human - readable file size. Example 1gb or 11.2mb
  */
 export declare const humanSizeToBytes: (human: string) => number;

package/types/core/helpers/normalize/normalize-color.d.ts

@@ -6,8 +6,7 @@
 /**
  * Convert rgba and short HEX color to Full text color. #fff to #FFFFFF
  *
- * @method normalizeColor
- * @param {string} colorInput - string like rgba(red, green, blue, alpha) or rgb(red, green, blue) or #fff or #ffffff
- * @return {string|boolean} HEX color, false - for transparent color
+ * @param colorInput - string like rgba(red, green, blue, alpha) or rgb(red, green, blue) or #fff or #ffffff
+ * @returns HEX color, false - for transparent color
  */
 export declare const normalizeColor: (colorInput: string) => string | false;

package/types/core/helpers/normalize/normalize-key-aliases.d.ts

@@ -5,7 +5,5 @@
  */
 /**
  * Normalize keys to some standard name
- *
- * @param keys
  */
 export declare function normalizeKeyAliases(keys: string): string;

package/types/core/helpers/normalize/normalize-path.d.ts

@@ -5,7 +5,5 @@
  */
 /**
  * Replaces back slashes and correctly concatenates several parts of the path.
- * @param path
- * @see Test helpers
  */
 export declare const normalizePath: (...path: string[]) => string;

package/types/core/helpers/normalize/normalize-size.d.ts

@@ -5,8 +5,5 @@
  */
 /**
  * Normalize value to CSS meters
- * @method normalizeSize
- * @param {string|int} value Input string
- * @return {string}
  */
 export declare const normalizeSize: (value: string | number) => string;

package/types/core/helpers/selector.d.ts

@@ -23,25 +23,17 @@ export declare function $$<K extends HTMLTagNames>(selector: K, root: HTMLElemen
 export declare function $$<T extends HTMLElement>(selector: string, root: HTMLElement | HTMLDocument): T[];
 /**
  * Calculate XPath selector
- *
- * @param element
- * @param root
  */
 export declare const getXPathByElement: (element: HTMLElement, root: HTMLElement) => string;
 /**
  * Find all `ref` or `data-ref` elements inside HTMLElement
- * @param root
  */
 export declare const refs: <T extends HTMLElement>(root: HTMLElement | UIElement) => IDictionary<T>;
 /**
  * Calculate full CSS selector
- * @param el
  */
 export declare const cssPath: (el: Element) => Nullable<string>;
 /**
  * Try to find element by selector
- *
- * @param element
- * @param od
  */
 export declare function resolveElement(element: string | HTMLElement, od: ShadowRoot | Document): HTMLElement;

package/types/core/helpers/size/get-content-width.d.ts

@@ -5,7 +5,5 @@
  */
 /**
  *
- * @param element
- * @param win
  */
 export declare const getContentWidth: (element: HTMLElement, win: Window) => number;

package/types/core/helpers/size/offset.d.ts

@@ -5,13 +5,7 @@
  */
 /**
  * Calc relative offset by start editor field
- *
- * @method offset
- * @param {HTMLElement} elm
- * @param {Jodit} jodit
- * @param {Document} doc
- * @param {boolean} recurse
- * @return {{top: number, left: number}} returns an object containing the properties top and left.
+ * @returns returns an object containing the properties top and left.
  */
 import type { IBound, IViewBased } from '../../../types';
 export declare const offset: (elm: HTMLElement | Range, jodit: IViewBased, doc: Document, recurse?: boolean) => IBound;

package/types/core/helpers/string/camel-case.d.ts

@@ -4,7 +4,6 @@
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * Convert (kebab-case or snake_case) => camelCase
- * @param key
+ * Convert (kebab-case or snake_case) to camelCase
  */
 export declare const camelCase: (key: string) => string;

package/types/core/helpers/string/i18n.d.ts

@@ -6,17 +6,10 @@
 import type { ILanguageOptions } from '../../../types';
 /**
  * Simple variant sprintf function
- *
- * @param str
- * @param args
  */
 export declare const sprintf: (str: string, args?: (string | number)[] | undefined) => string;
 /**
  * Internationalization method. Uses Jodit.lang object
- *
- * @param {string} key Some text
- * @param {string[]} params Some text
- * @return {string}
  * @example
  * ```javascript
  * var editor = new Jodit("#redactor", {

package/types/core/helpers/string/kebab-case.d.ts

@@ -3,9 +3,5 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-/**
- *
- * @param key
- * @return {string}
- */
 export declare const kebabCase: (key: string) => string;
+export declare const CamelCaseToKebabCase: (key: string) => string;

package/types/core/helpers/string/stringify.d.ts

@@ -5,9 +5,6 @@
  */
 /**
  * Safe stringify circular object
- *
- * @param value
- * @param options
  */
 export declare function stringify(value: unknown, options?: {
     excludeKeys?: string[];

package/types/core/helpers/string/trim.d.ts

@@ -6,11 +6,9 @@
 /**
  * It clears the line of all auxiliary invisible characters , from the spaces and line breaks , tabs
  * from the beginning and end of the line
- * @param value input string
  */
 export declare function trim(value: string): string;
 /**
  * Trim only invisible chars
- * @param value
  */
 export declare function trimInv(value: string): string;

package/types/core/helpers/string/ucfirst.d.ts

@@ -5,8 +5,5 @@
  */
 /**
  * Make a string's first character uppercase
- *
- * @param {string} value input string
- * @return {string}
  */
-export declare const ucfirst: (value: string) => string;
+export declare function ucfirst(value: string): string;

package/types/core/helpers/type.d.ts

@@ -5,6 +5,5 @@
  */
 /**
  * Helper for create Error object
- * @param message
  */
 export declare function error(message: string): Error;

package/types/core/helpers/utils/get.d.ts

@@ -22,7 +22,5 @@ import type { IDictionary, Nullable } from '../../../types';
  * console.log(Jodit.modules.Helpers.get('a.b.c.d.e', obj) === false); // true
  * console.log(Jodit.modules.Helpers.get('a.b.a.d.e', obj) === null); // false
  * ```
- * @param chain
- * @param obj
  */
 export declare function get<T>(chain: string, obj: IDictionary): Nullable<T>;

package/types/core/helpers/utils/mark-deprecated.d.ts

@@ -10,9 +10,5 @@
 export declare const cns: Console;
 /**
  * Mark function as deprecated
- *
- * @param method
- * @param names
- * @param ctx
  */
 export declare function markDeprecated(method: Function, names?: string[], ctx?: any): (...args: any[]) => void;

package/types/core/helpers/utils/set.d.ts

@@ -16,7 +16,5 @@ import type { IDictionary } from '../../../types';
  * Jodit.modules.Helpers.set('a.0.e', 1, b);
  * console.log(b);// {a: [{e: 1}]}
  * ```
- * @param chain
- * @param obj
  */
 export declare function set<T>(chain: string, value: unknown, obj: IDictionary): void;

package/types/core/helpers/utils/utils.d.ts

@@ -3,12 +3,10 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
-import type { CanPromise, IControlType, IViewBased, Nullable, IJodit, RejectablePromise } from '../../../types';
+import type { CanPromise, IControlType, IDictionary, IViewBased, Nullable, IJodit, RejectablePromise } from '../../../types';
 /**
  * Call function with parameters
  *
- * @param func
- * @param args
  * @example
  * ```js
  * const f = Math.random();
@@ -20,21 +18,17 @@ export declare function call<T extends any[], R>(func: (...args: T) => R, ...arg
  * Alias for `elm.getAttribute` but if set second argument `-{key}`
  * it will also check `data-{key}` attribute
  * if set `value` it is alias for setAttribute with same logic
- *
- * @param elm
- * @param key
- * @param [value]
  */
-export declare function attr(elm: Element | null, key: string, value?: string | number | boolean | null): null | string;
+export declare function attr(elm: Element, key: string): null | string;
+export declare function attr(elm: Element, key: string, value: string | number | boolean | null | undefined): null;
+export declare function attr(elm: Element, attributes: IDictionary<string | number | boolean | null>): null;
 /**
  * Mark element for debugging
- * @param elm
  */
 export declare function markOwner(jodit: IViewBased, elm: HTMLElement): void;
 export declare function callPromise(condition: CanPromise<unknown>, callback: () => CanPromise<any>): CanPromise<void>;
 /**
  * Reset Vanila JS native function
- * @param key
  * @example
  * ```js
  * reset('Array.from')(Set([1,2,3])) // [1, 2, 3]
@@ -43,16 +37,11 @@ export declare function callPromise(condition: CanPromise<unknown>, callback: ()
 export declare const reset: <T extends Function>(key: string) => Nullable<T>;
 /**
  * Allow load image in promise
- * @param src
- * @param jodit
  */
 export declare const loadImage: (src: string, jodit: IViewBased) => RejectablePromise<HTMLImageElement>;
 export declare const keys: (obj: object, own?: boolean) => string[];
 /**
  * Memorize last user chose
- * @param editor
- * @param _
- * @param control
  */
 export declare const memorizeExec: <T extends IJodit = IJodit>(editor: T, _: unknown, { control }: {
     control: IControlType<T, import("../../../types").IToolbarButton>;