jodit 3.20.2 → 3.20.3

package/types/core/dom/index.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 dom
- */
 export * from './dom';
 export * from './lazy-walker';

package/types/core/dom/lazy-walker.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 dom
- */
 import type { IAsync, IDestructible } from 'jodit/types';
 import { Eventify } from 'jodit/core/event-emitter/eventify';
 export declare class LazyWalker extends Eventify<{

package/types/core/event-emitter/event-emitter.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:core/event-emitter/README.md]]
- * @packageDocumentation
- * @module event-emitter
- */
 import type { CallbackFunction, CanArray, IEventEmitter, IEventEmitterOnOptions } from 'jodit/types';
-/**
- * The module editor's event manager
- */
 export declare class EventEmitter implements IEventEmitter {
     private __mutedEvents;
     mute(event?: string): this;
@@ -24,109 +16,18 @@ export declare class EventEmitter implements IEventEmitter {
     private __removeStoreFromSubject;
     private __prepareEvent;
     private __triggerNativeEvent;
-    /**
-     * Get current event name
-     *
-     * @example
-     * ```javascript
-     * parent.e.on('openDialog closeDialog', function () {
-     *     if (parent.e.current === 'closeDialog') {
-     *         alert('Dialog was closed');
-     *     } else {
-     *         alert('Dialog was opened');
-     *     }
-     * });
-     * ```
-     */
     get current(): string;
     currents: string[];
-    /**
-     * Sets the handler for the specified event ( Event List ) for a given element
-     *
-     * @example
-     * ```javascript
-     * // set global handler
-     * editor.events.on('beforeCommand', function (command) {
-     *     alert('command');
-     * });
-     * ```
-     * * @example
-     * ```javascript
-     * // set global handler
-     * editor.events.on(document.body, 'click', function (e) {
-     *     alert(this.href);
-     * });
-     * ```
-     */
     on(events: CanArray<string>, callback: CallbackFunction, options?: IEventEmitterOnOptions): this;
     on(subjects: CanArray<HTMLElement | Window | object>, events: CanArray<string>, callback: CallbackFunction, options?: IEventEmitterOnOptions): this;
     one(eventsOrSubjects: CanArray<string> | CanArray<HTMLElement | Window | object>, callbackOrEvents: CallbackFunction | CanArray<string>, optionsOrCallback: IEventEmitterOnOptions | CallbackFunction | void, opts?: IEventEmitterOnOptions): this;
-    /**
-     * Disable all handlers specified event ( Event List ) for a given element. Either a specific event handler.
-     *
-     * @param subjectOrEvents - The object which is disabled handlers
-     * @param eventsOrCallback - List of events, separated by a space or comma , which is necessary
-     * to disable the handlers for a given object
-     * @param handler - Specific event handler to be removed
-     *
-     * @example
-     * ```javascript
-     * var a = {name: "Anton"};
-     * parent.e.on(a, 'open', function () {
-     *     alert(this.name);
-     * });
-     *
-     * parent.e.fire(a, 'open');
-     * parent.e.off(a, 'open');
-     * var b = {name: "Ivan"}, hndlr = function () {
-     *  alert(this.name);
-     * };
-     * parent.e.on(b, 'open close', hndlr);
-     * parent.e.fire(a, 'open');
-     * parent.e.off(a, 'open', hndlr);
-     * parent.e.fire(a, 'close');
-     * parent.e.on('someGlobalEvents', function () {
-     *   console.log(this); // parent
-     * });
-     * parent.e.fire('someGlobalEvents');
-     * parent.e.off('someGlobalEvents');
-     * ```
-     */
     off(events: CanArray<string>, callback?: CallbackFunction): this;
     off(subjects: CanArray<Window | HTMLElement | object>, events?: CanArray<string>, callback?: CallbackFunction): this;
-    /**
-     * Stop execute all another listeners for this event
-     */
     stopPropagation(events: string): void;
     stopPropagation(subject: object, eventsList: string): void;
     private __stopped;
     private __removeStop;
     private __isStopped;
-    /**
-     * Emits an event to all handlers and calls them
-     *
-     * @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();
-     * parent.e.on('afterClose', function () {
-     *     dialog.destruct(); // will be removed from DOM
-     * });
-     * dialog.open('Hello world!!!');
-     * ```
-     *  or you can trigger native browser listener
-     * ```javascript
-     *  var events = new Jodit.modules.EventEmitter();
-     *  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;
     fire(subjectOrEvents: object, eventsList: string | Event, ...args: any[]): any;
     private __isDestructed;

package/types/core/event-emitter/eventify.d.ts

@@ -3,32 +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
  */
-/**
- * @module event-emitter
- */
 import type { CanUndef, IDestructible } from 'jodit/types';
-/**
- * Class for adding event handling capability
- *
- * ```ts
- * class SomeClass extends Eventify<{ start: (node: Node) => boolean; }> {
- * 	constructor() {
- * 		super();
- * 		setTimeout(() => {
- * 			if (this.emit('start', document.body)) {
- * 				console.log('yes');
- * 			};
- * 		}, 100);
- * 	}
- * }
- *
- * const sm = new SomeClass();
- * sm.on('start', (node) => {
- * 	console.log(node);
- * 	return true;
- * })
- * ```
- */
 export declare abstract class Eventify<MAP extends {
     [key: string]: (...args: any[]) => any;
 }, EVENT extends keyof MAP = keyof MAP> implements IDestructible {

package/types/core/event-emitter/index.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 event-emitter
- */
 export * from './event-emitter';
 export * from './eventify';
 export * from './observable';

package/types/core/event-emitter/observable.d.ts

@@ -3,43 +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 event-emitter
- */
 import type { IObservable, IDictionary } from 'jodit/types';
-/**
- * Makes any object an observable object
- * @example
- * ```js
- * const obj = {
- *   a: 1,
- *   b: {
- *     c: 5
- *   }
- * }
- *
- * const obsObj = Jodit.modules.observable(obj);
- * console.log(obj === obsObj); // true
- * obsObj.on('change', () => {
- *   console.log('Object changed');
- * });
- * obsObj.on('change.a', () => {
- *   console.log('Key a changed');
- * });
- * obsObj.on('change.b.c', () => {
- *   console.log('Key b.c changed');
- * });
- *
- * obj.a = 6;
- * // Object changed
- * // Key a changed
- *
- * obj.b = {c: 6}
- * // Object changed
- *
- * obj.b.c = 8
- * // Object changed
- * // Key b.c changed
- * ```
- */
 export declare function observable<T extends IDictionary, O extends T & IObservable>(obj: T): O;

package/types/core/event-emitter/store.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 event-emitter
- */
 import type { CallbackFunction, EventHandlerBlock } from 'jodit/types';
 export declare const defaultNameSpace = "JoditEventDefaultNamespace";
 export declare class EventHandlersStore {

package/types/core/global.d.ts

@@ -3,25 +3,13 @@
  * 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 global
- */
 import type { HTMLTagNames, IDictionary, IJodit, IViewBased, IViewComponent } from 'jodit/types';
 import { PluginSystem } from './plugin/plugin-system';
 import { EventEmitter } from './event-emitter';
 export declare const instances: IDictionary<IJodit>;
-/**
- * Generate global unique uid
- */
 export declare function uniqueUid(): string;
 export declare const pluginSystem: PluginSystem;
 export declare const modules: IDictionary<Function>;
 export declare const extendLang: (langs: IDictionary) => void;
-/**
- * Create unique box(HTMLCotainer) and remove it after destroy
- */
 export declare function getContainer<T extends HTMLTagNames = HTMLTagNames>(jodit: IViewBased | IViewComponent, classFunc?: Function, tag?: T, createInsideEditor?: boolean): HTMLElementTagNameMap[T];
-/**
- * Global event emitter
- */
 export declare const eventEmitter: EventEmitter;

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

@@ -3,7 +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
  */
-/**
- * Always return Array
- */
 export declare const asArray: <T>(a: T | T[]) => T[];

package/types/core/helpers/array/index.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 helpers/array
- */
 export { asArray } from './as-array';
 export { splitArray } from './split-array';
 export { toArray } from './to-array';

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

@@ -3,12 +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 helpers/array
- */
-/**
- * Split separated elements
- */
 export declare function splitArray(a: string): string[];
 export declare function splitArray<T extends any[]>(a: T): T;
 export declare function splitArray<T extends any[]>(a: T | string): T | string[];

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

@@ -3,10 +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
  */
-/**
- * Always return Array. In some cases(Joomla Mootools)
- * Array.from can be replaced to some bad implementation.
- */
 export declare const toArray: {
     <T>(arrayLike: ArrayLike<T>): T[];
     <T_1, U>(arrayLike: ArrayLike<T_1>, mapfn: (v: T_1, k: number) => U, thisArg?: any): U[];

package/types/core/helpers/async/index.d.ts

@@ -3,7 +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
  */
-/**
- * @module helpers/async
- */
 export * from './set-timeout';

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

@@ -3,14 +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 helpers/async
- */
-/**
- * Create async callback if set timeout value - else call function immediately
- */
 export declare function setTimeout<T = any>(callback: (...args: T[]) => void, timeout: number, ...args: T[]): number;
-/**
- * Clear timeout
- */
 export declare function clearTimeout(timer: number): void;

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check if browser has a color picker (a new HTML5 attribute for input tag)
- */
 export declare function hasBrowserColorPicker(): boolean;

package/types/core/helpers/checker/index.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 helpers/checker
- */
 export * from './has-browser-color-picker';
 export * from './is-array';
 export * from './is-boolean';

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check if element is array
- */
 export declare function isArray<T = any>(elm: unknown): elm is T[];

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

@@ -3,7 +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
  */
-/**
- * @module helpers/checker
- */
 export declare function isBoolean(elm: unknown): elm is Boolean;

package/types/core/helpers/checker/is-equal.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
  */
-/**
- * Check two element are equal
- */
 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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check value is Function
- */
 export declare function isFunction(value: unknown): value is Function;

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Detect if string is HTML from MS Word or Excel
- */
 export declare function isHtmlFromWord(data: string): boolean;

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

@@ -3,7 +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
  */
-/**
- * Check if a string is html or not
- */
 export declare const isHTML: (str: unknown) => str is string;

package/types/core/helpers/checker/is-imp-interface.d.ts

@@ -3,19 +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
  */
-/**
- * @module helpers/checker
- */
 import type { IContainer, IDestructible, IInitable } from 'jodit/types';
-/**
- * Check value has method init
- */
 export declare function isInitable(value: unknown): value is IInitable;
-/**
- * Check value has method destruct
- */
 export declare function isDestructable(value: unknown): value is IDestructible;
-/**
- * Check value is instant that implements IContainer
- */
 export declare function hasContainer(value: unknown): value is IContainer;

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

@@ -3,7 +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
  */
-/**
- * Check value is Int
- */
 export declare function isInt(value: number | string): boolean;

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

@@ -3,11 +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 helpers/checker
- */
 import type { IJodit } from 'jodit/types';
-/**
- * Check if element is instance of Jodit
- */
 export declare function isJoditObject(jodit: unknown): jodit is IJodit;

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check if function or method was not replaced on some custom implementation
- */
 export declare function isNativeFunction(f: Function): boolean;

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check value is a number
- */
 export declare function isNumber(value: unknown): value is number;

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

@@ -3,7 +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
  */
-/**
- * Check value has numeric format
- */
 export declare function isNumeric(value: number | string): boolean;

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

@@ -3,11 +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 helpers/checker
- */
 import type { IDictionary } from 'jodit/types';
-/**
- * Check if element is simple plaint object
- */
 export declare function isPlainObject<T>(obj: any | IDictionary<T>): obj is IDictionary<T>;

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

@@ -3,7 +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
  */
-/**
- * @module helpers/checker
- */
 export declare function isPromise(val: any | Promise<any>): val is Promise<any>;

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

@@ -3,11 +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
  */
-/**
- * Check value is String
- */
 export declare function isString(value: unknown): value is string;
-/**
- * Check value is Array of String
- */
 export declare function isStringArray(value: unknown): value is string[];

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check if a string is a url
- */
 export declare function isURL(str: string): boolean;

package/types/core/helpers/checker/is-valid-name.d.ts

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check if name has normal format
- */
 export declare function isValidName(name: string): boolean;

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

@@ -3,11 +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 helpers/checker
- */
 import type { IViewBased } from 'jodit/types';
-/**
- * Check if element is instance of View
- */
 export declare function isViewObject(jodit: unknown): jodit is IViewBased;

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

@@ -3,10 +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
  */
-/**
- * @module helpers/checker
- */
-/**
- * Check value is undefined or null
- */
 export declare function isVoid(value: unknown): value is undefined | null;

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

@@ -3,7 +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
  */
-/**
- * @module helpers/checker
- */
 export declare function isWindow(obj: object): boolean;

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

@@ -3,20 +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
  */
-/**
- * @module helpers/color
- */
-/**
- * Converts rgba text representation of color in hex
- *
- * @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');
- * p.style.color = '#ffffff';
- * console.log(p.getAttribute('style')); // color: rgb(255, 255, 255);
- * console.log(colorTohex(p.style.color)); // #ffffff
- * ```
- */
 export declare const colorToHex: (color: string) => string | false;

package/types/core/helpers/color/index.d.ts

@@ -3,7 +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
  */
-/**
- * @module helpers/color
- */
 export * from './color-to-hex';

package/types/core/helpers/html/apply-styles.d.ts

@@ -3,9 +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
  */
-/**
- * If the HTML has CSS rules with selectors,
- * it applies them to the selectors in the HTML itself
- * and then removes the selector styles, leaving only the inline ones.
- */
 export declare function applyStyles(html: string): string;

package/types/core/helpers/html/clean-from-word.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
  */
-/**
- * The method automatically cleans up content from Microsoft Word and other HTML sources to ensure clean, compliant
- * content that matches the look and feel of the site.
- */
 export declare function cleanFromWord(html: string): string;