jodit 3.8.4 → 3.8.8

package/src/config.ts

@@ -94,13 +94,11 @@ export class Config implements IViewOptions {
 
 	/**
 	 * Change the read-only state of the editor
-	 * @type {boolean}
 	 */
 	readonly: boolean = false;
 
 	/**
 	 * Change the disabled state of the editor
-	 * @type {boolean}
 	 */
 	disabled: boolean = false;
 
@@ -132,8 +130,6 @@ export class Config implements IViewOptions {
 
 	/**
 	 * Inline editing mode
-	 *
-	 * @type {boolean}
 	 */
 	inline: boolean = false;
 
@@ -199,7 +195,7 @@ export class Config implements IViewOptions {
 	 * After all changes in editors for textarea will call change trigger
 	 *
 	 * @example
-	 *  ```javascript
+	 * ```javascript
 	 * var editor = new Jodit('#editor');
 	 * document.getElementById('editor').addEventListener('change', function () {
 	 *      console.log(this.value);
@@ -257,7 +253,7 @@ export class Config implements IViewOptions {
 	debugLanguage: boolean = false;
 
 	/**
-	 * Collection of language pack data {en: {'Type something': 'Type something', ...}}
+	 * Collection of language pack data `{en: {'Type something': 'Type something', ...}}`
 	 *
 	 * @example
 	 * ```javascript
@@ -304,7 +300,6 @@ export class Config implements IViewOptions {
 
 	/**
 	 * Instead of create custop tooltip - use native title tooltips
-	 * @type {boolean}
 	 */
 	useNativeTooltip: boolean = false;
 
@@ -341,8 +336,6 @@ export class Config implements IViewOptions {
 
 	/**
 	 * Use split mode
-	 *
-	 * @type {boolean}
 	 */
 	useSplitMode: boolean = false;
 
@@ -514,6 +507,7 @@ export class Config implements IViewOptions {
 	 * But for a declarative declaration, you can use this option.
 	 *
 	 * @example
+	 * ```js
 	 * Jodit.modules.Icon.set('someIcon', '<svg><path.../></svg>');
 	 * const editor = Jodit.make({
 	 *   extraButtons: [{
@@ -532,14 +526,16 @@ export class Config implements IViewOptions {
 	 *     icon: 'someIcon'
 	 *   }]
 	 * });
-	 *
+	 * ```
 	 * @example
+	 * ```js
 	 * const editor = Jodit.make({
 	 *   extraButtons: [{
 	 *     name: 'someButton',
 	 *     icon: '<svg><path.../></svg>'
 	 *   }]
 	 * });
+	 * ```
 	 */
 	extraIcons: IDictionary<string> = {};
 
@@ -624,7 +620,7 @@ export class Config implements IViewOptions {
 	 *            return '<div>' + value + '</div>';
 	 *        }
 	 *  });
-	 *  ```
+	 * ```
 	 */
 	buttons: ButtonsOption = [
 		{
@@ -760,7 +756,7 @@ export class Config implements IViewOptions {
 	];
 
 	/**
-	 * The list of buttons that appear in the editor's toolbar on extra small places (< options.sizeSM).
+	 * The list of buttons that appear in the editor's toolbar on extra small places `(< options.sizeSM)`.
 	 */
 	buttonsXS: ButtonsOption = [
 		'bold',
@@ -787,13 +783,11 @@ export class Config implements IViewOptions {
 
 	/**
 	 * Buttons in toolbat without SVG - only texts
-	 * @type {boolean}
 	 */
 	textIcons: boolean = false;
 
 	/**
 	 * shows a INPUT[type=color] to open the browser color picker, on the right bottom of widget color picker
-	 * @type {boolean}
 	 */
 	showBrowserColorPicker: boolean = true;
 

package/src/core/ajax.ts

@@ -23,35 +23,11 @@ import {
 	ConfigProto
 } from './helpers';
 
-/**
- * @property {object} defaultAjaxOptions A set of key/value pairs that configure the Ajax request. All settings
- * are optional
- * @property {object} defaultAjaxOptions.headers An object of additional header key/value pairs toWYSIWYG send along
- * with requests using the XMLHttpRequest transport. Uses in {@link FileBrowser|FileBrowser}
- * and {@link Uploader|Uploader}
- * @property {string} defaultAjaxOptions.dataType='json' json or text The type of data that you're expecting back
- * from the server. if `json` the return value passes through the `JSON.parse`
- * @property {string} defaultAjaxOptions.method='GET' The HTTP method toWYSIWYG use for the request
- * (e.g. "POST", "GET", "PUT")
- * @property {string} defaultAjaxOptions.url='' A string containing the URL toWYSIWYG which the request is sent.
- * @property {string} defaultAjaxOptions.async=true By default, all requests are sent asynchronously (i.e. this is
- * set toWYSIWYG true by default). If you need synchronous requests, set this option toWYSIWYG false
- * @property {object|string} defaultAjaxOptions.data=null Data toWYSIWYG be sent toWYSIWYG the server.
- * It is converted toWYSIWYG a query string, if not already a string. It's appended toWYSIWYG the url for GET-requests.
- * @property {string} defaultAjaxOptions.contentType='application/x-www-form-urlencoded; charset=UTF-8'
- * When sending data toWYSIWYG the server, use this content type. Default is "application/x-www-form-urlencoded;
- * charset=UTF-8", which is fine for most cases
- * @property {boolean} defaultAjaxOptions.withCredentials=false
- * Enable or disable Access-Control-Allow-Credentials client side. Useful for cross domain requests
- * @property {function} defaultAjaxOptions.error=function () {} A function toWYSIWYG be called if the request fails
- * @property {function} defaultAjaxOptions.success=function (resp) {} A function toWYSIWYG be called if the
- * request succeeds
- * @property {function} defaultAjaxOptions.xhr=function () { return new XMLHttpRequest(); } Callback for creating
- * the XMLHttpRequest object.
- */
-
 declare module '../config' {
 	interface Config {
+		/**
+		 * A set of key/value pairs that configure the Ajax request. All settings are optional
+		 */
 		defaultAjaxOptions: AjaxOptions;
 	}
 }
@@ -59,11 +35,8 @@ declare module '../config' {
 Config.prototype.defaultAjaxOptions = {
 	dataType: 'json',
 	method: 'GET',
-
 	url: '',
-
 	data: null,
-
 	contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
 
 	headers: {
@@ -82,7 +55,7 @@ export class Ajax implements IAjax {
 
 	private readonly xhr!: XMLHttpRequest;
 
-	private success_response_codes = [200, 201, 202];
+	private successResponseCodes = [200, 201, 202];
 
 	private __buildParams(
 		obj: string | IDictionary<string | object> | FormData,
@@ -130,16 +103,16 @@ export class Ajax implements IAjax {
 	private resolved = false;
 	private activated = false;
 
-	send(): Promise<any> {
+	send<T = any>(): Promise<T> {
 		this.activated = true;
 
 		return new Promise(
 			(
-				resolve: (this: XMLHttpRequest, resp: object) => any,
+				resolve: (this: XMLHttpRequest, resp: T) => any,
 				reject: (error: Error) => any
 			) => {
-				const __parse = (resp: string): object => {
-					let result: object | null = null;
+				const __parse = (resp: string): T => {
+					let result: T | null = null;
 
 					if (this.o.dataType === 'json') {
 						result = JSON.parse(resp);
@@ -169,7 +142,7 @@ export class Ajax implements IAjax {
 					this.status = this.xhr.status;
 					this.resolved = true;
 
-					resolve.call(this.xhr, __parse(this.response) || {});
+					resolve.call(this.xhr, __parse(this.response) || ({} as T));
 				};
 
 				this.xhr.onprogress = (e): void => {
@@ -193,9 +166,8 @@ export class Ajax implements IAjax {
 						this.resolved = true;
 
 						if (
-							this.success_response_codes.indexOf(
-								this.xhr.status
-							) > -1
+							this.successResponseCodes.indexOf(this.xhr.status) >
+							-1
 						) {
 							resolve.call(this.xhr, __parse(resp));
 						} else {
@@ -230,7 +202,7 @@ export class Ajax implements IAjax {
 				}
 
 				// IE
-				setTimeout(() => {
+				this.j.async.setTimeout(() => {
 					this.xhr.send(data ? this.__buildParams(data) : undefined);
 				}, 0);
 			}
@@ -243,6 +215,7 @@ export class Ajax implements IAjax {
 		}
 
 		let url: string = this.o.url;
+
 		const data = this.o.data;
 		const method = (this.o.method || 'get').toLowerCase();
 
@@ -251,6 +224,7 @@ export class Ajax implements IAjax {
 
 			if (qIndex !== -1) {
 				const urlData = parseQuery(url);
+
 				url =
 					url.substr(0, qIndex) +
 					'?' +
@@ -280,14 +254,10 @@ export class Ajax implements IAjax {
 
 		this.xhr = this.o.xhr ? this.o.xhr() : new XMLHttpRequest();
 
-		jodit &&
-			jodit.events &&
-			jodit.e.on('beforeDestruct', () => {
-				this.abort();
-			});
+		jodit && jodit.e && jodit.e.on('beforeDestruct', () => this.abort());
 	}
 
-	destruct(): any {
+	destruct(): void {
 		if (this.activated && !this.resolved) {
 			this.abort();
 			this.resolved = true;

package/src/core/async.ts

@@ -74,10 +74,6 @@ export class Async implements IAsync {
 	 * Debouncing enforces that a function not be called again until a certain amount of time has passed without
 	 * it being called. As in "execute this function only if 100 milliseconds have passed without it being called."
 	 *
-	 * @param {function} fn
-	 * @param {int} timeout
-	 * @return {function}
-	 *
 	 * @example
 	 * ```javascript
 	 * var jodit = new Jodit('.editor');
@@ -86,9 +82,6 @@ export class Async implements IAsync {
 	 * }, 100));
 	 * ```
 	 *
-	 * @param fn
-	 * @param timeout
-	 * @param firstCallImmediately
 	 */
 	debounce(
 		fn: CallbackFunction,
@@ -128,6 +121,7 @@ export class Async implements IAsync {
 				}
 
 				clearTimeout(timer);
+
 				timer = this.setTimeout(
 					() => callFn(...args),
 					isFunction(timeout) ? timeout() : timeout
@@ -154,11 +148,6 @@ export class Async implements IAsync {
 	 * Throttling enforces a maximum number of times a function can be called over time.
 	 * As in "execute this function at most once every 100 milliseconds."
 	 *
-	 * @method throttle
-	 * @param {function} fn
-	 * @param {int} timeout
-	 * @param {context} [ctx] Context
-	 * @return {function}
 	 * @example
 	 * ```javascript
 	 * var jodit = new Jodit('.editor');
@@ -241,7 +230,6 @@ export class Async implements IAsync {
 
 	/**
 	 * Get Promise status
-	 * @param p
 	 */
 	promiseState(
 		p: Promise<any>
@@ -282,7 +270,7 @@ export class Async implements IAsync {
 
 	private requestIdleCallbackNative =
 		(window as any)['requestIdleCallback']?.bind(window) ??
-		((callback: CallbackFunction): number => {
+		((callback: IdleRequestCallback): number => {
 			const start = Date.now();
 
 			return this.setTimeout(() => {
@@ -299,14 +287,14 @@ export class Async implements IAsync {
 			this.clearTimeout(request);
 		});
 
-	requestIdleCallback(callback: CallbackFunction): number {
+	requestIdleCallback(callback: IdleRequestCallback): number {
 		const request = this.requestIdleCallbackNative(callback);
 		this.requestsIdle.add(request);
 		return request;
 	}
 
-	requestIdlePromise(): Promise<number> {
-		return new Promise<number>(res => {
+	requestIdlePromise(): RejectablePromise<number> {
+		return this.promise<number>(res => {
 			const request = this.requestIdleCallback(() => res(request));
 		});
 	}
@@ -330,6 +318,7 @@ export class Async implements IAsync {
 		this.promisesRejections.forEach(reject => {
 			reject();
 		});
+
 		this.promisesRejections.clear();
 	}
 

package/src/core/component/view-component.ts

@@ -33,7 +33,6 @@ export abstract class ViewComponent<T extends IViewBased = IViewBased>
 
 	/**
 	 * Attach component to View
-	 * @param jodit
 	 */
 	setParentView(jodit: T): this {
 		this.jodit = jodit;

package/src/core/constants.ts

@@ -74,23 +74,23 @@ export const BR = 'br';
 export const PARAGRAPH = 'p';
 
 /**
- * @property {int} MODE_WYSIWYG=1 WYSIWYG editor mode
+ * WYSIWYG editor mode
  */
 export const MODE_WYSIWYG = 1;
 
 /**
- * @property {int} MODE_SOURCE=2 html editor mode
+ * html editor mode
  */
 export const MODE_SOURCE = 2;
 
 /**
- * @property {int} MODE_SPLIT=3  Source code editor and HTML editor both like
+ * Source code editor and HTML editor both like
  * {@link http://getuikit.com/docs/htmleditor.html|this}
  */
 export const MODE_SPLIT = 3;
 
 /**
- * @property {boolean} Is Internet Explorer
+ * Is Internet Explorer
  */
 export const IS_IE =
 	typeof navigator !== 'undefined' &&
@@ -98,7 +98,7 @@ export const IS_IE =
 		/rv:11.0/i.test(navigator.userAgent));
 
 /**
- * @property {string} TEXT_PLAIN='text/plain'  For IE11 it will be 'text'. Need for dataTransfer.setData
+ * For IE11 it will be 'text'. Need for dataTransfer.setData
  */
 export const TEXT_PLAIN = IS_IE ? 'text' : 'text/plain';
 export const TEXT_HTML = IS_IE ? 'html' : 'text/html';

package/src/core/create.ts

@@ -15,13 +15,11 @@ import type {
 
 import {
 	isPlainObject,
-	each,
 	asArray,
-	css,
 	isFunction,
-	kebabCase,
 	refs,
-	isString
+	isString,
+	attr
 } from './helpers/';
 
 import { Dom } from './dom';
@@ -39,23 +37,6 @@ export class Create implements ICreate {
 		>
 	) {}
 
-	/**
-	 * Apply some object key-value to HTMLElement
-	 */
-	private applyAttributes = (elm: HTMLElement, attrs: Attributes) => {
-		each(attrs, (key: string, value) => {
-			if (isPlainObject(value) && key === 'style') {
-				css(elm, value as IDictionary<string>);
-			} else {
-				if (key === 'className') {
-					key = 'class';
-				}
-
-				elm.setAttribute(kebabCase(key), value.toString());
-			}
-		});
-	};
-
 	element<K extends keyof HTMLElementTagNameMap>(
 		tagName: K,
 		children?: Children
@@ -76,7 +57,7 @@ export class Create implements ICreate {
 
 		if (childrenOrAttributes) {
 			if (isPlainObject(childrenOrAttributes)) {
-				this.applyAttributes(elm, childrenOrAttributes as Attributes);
+				attr(elm, <IDictionary>childrenOrAttributes);
 			} else {
 				children = childrenOrAttributes as Children;
 			}
@@ -229,12 +210,12 @@ export class Create implements ICreate {
 			const ca = this.createAttributes;
 
 			if (ca && ca[elm.tagName.toLowerCase()]) {
-				const attrs = ca[elm.tagName.toLowerCase()];
+				const attrsOpt = ca[elm.tagName.toLowerCase()];
 
-				if (isFunction(attrs)) {
-					attrs(elm);
-				} else if (isPlainObject(attrs)) {
-					this.applyAttributes(elm, attrs);
+				if (isFunction(attrsOpt)) {
+					attrsOpt(elm);
+				} else if (isPlainObject(attrsOpt)) {
+					attr(elm, <IDictionary>attrsOpt);
 				}
 			}
 		}

package/src/core/decorators/debounce.ts

@@ -22,10 +22,6 @@ import { Component, STATUSES } from '../component';
 
 /**
  * Wrap function in debounce wrapper
- *
- * @param timeout
- * @param firstCallImmediately
- * @param method
  */
 export function debounce<V = IViewComponent | IViewBased>(
 	timeout?: number | ((ctx: V) => number | IAsyncParams) | IAsyncParams,
@@ -62,10 +58,6 @@ export function debounce<V = IViewComponent | IViewBased>(
 
 /**
  * Wrap function in throttle wrapper
- *
- * @param timeout
- * @param firstCallImmediately
- * @param method
  */
 export function throttle<V = IViewComponent | IViewBased>(
 	timeout?: number | ((ctx: V) => number | IAsyncParams) | IAsyncParams,

package/src/core/decorators/hook.ts

@@ -15,7 +15,6 @@ import { error, isFunction } from '../helpers';
 
 /**
  * Call on some component status
- * @param timeout
  */
 export function hook(status: ComponentStatus) {
 	return <T extends Component & IDictionary>(

package/src/core/decorators/nonenumerable.ts

@@ -5,8 +5,7 @@
  */
 
 /**
- * @enumerable decorator that sets the enumerable property of a class field to false.
- * @param value true|false
+ * Decorator that sets the enumerable property of a class field to false.
  */
 export const nonenumerable = (target: object, propertyKey: string): void => {
 	const descriptor =

package/src/core/decorators/persistent.ts

@@ -10,9 +10,6 @@ import { isViewObject } from '../helpers';
 
 /**
  * Allow save value inside persistent storage as set/get to property
- *
- * @param target
- * @param propertyKey
  */
 export function persistent<T extends IComponent>(
 	target: T,

package/src/core/decorators/spy.ts

@@ -14,7 +14,6 @@ import { getClassName } from '../helpers/utils';
 
 /**
  * Allow spy for the class
- * @param target
  */
 export const spy = function spy(target: Function): void {
 	const methods = Reflect.ownKeys(target.prototype);

package/src/core/decorators/wait.ts

@@ -10,7 +10,6 @@ import { STATUSES } from '../component';
 
 /**
  * Wrap function in wait wrapper, it will be called after `condition` returns `true`
- * @param condition
  */
 export function wait<T extends IViewBased>(
 	condition: (ctx: T) => boolean