Helpers/utils

ClassesClasses

• ConnectionError
• OptionsError
• LimitedStack

LoaderLoader

Loader: (jodit: IViewBased, url: string) => Promise<any>

Type declarationType declaration

(jodit, url): Promise<any>

ParametersParameters

ReturnsReturns

Promise<any>

Defined inDefined in

src/core/helpers/utils/append-script.ts#16

AbortErrorAbortError

AbortError: DOMException & { name: "AbortError" }

AbortError is not a separate exception, but rather a DOMException with a special name.
https://webidl.spec.whatwg.org/#aborterror

Defined inDefined in

src/core/helpers/utils/error/errors/abort-error.ts#17

alreadyLoadedListalreadyLoadedList

Const alreadyLoadedList: Map<string, Promise<any>>

Defined inDefined in

src/core/helpers/utils/append-script.ts#18

keepNameskeepNames

Const keepNames: Map<Function, string>

Defined inDefined in

src/core/helpers/utils/get-class-name.ts#14

cnscns

Const cns: Console = console

By default, terser will remove all console.* but
if you use this object it will not be

Defined inDefined in

src/core/helpers/utils/mark-deprecated.ts#15

hAlignElementhAlignElement

hAlignElement(image, align): void

Align image

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/align.ts#18

clearAlignclearAlign

clearAlign(node): void

Remove text-align style for all selected children

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/align.ts#48

alignElementalignElement

alignElement(command, box): void

Apply align for element

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/align.ts#65

appendScriptAsyncappendScriptAsync

appendScriptAsync(jodit, url): Promise<any>

Load script and return promise

ParametersParameters

ReturnsReturns

Promise<any>

Defined inDefined in

src/core/helpers/utils/append-script.ts#37

appendStyleAsyncappendStyleAsync

appendStyleAsync(jodit, url): Promise<any>

Download CSS style script

ParametersParameters

ReturnsReturns

Promise<any>

Defined inDefined in

src/core/helpers/utils/append-script.ts#61

loadNextloadNext

loadNext(jodit, urls, i?): Promise<void>

ParametersParameters

ReturnsReturns

Promise<void>

Defined inDefined in

src/core/helpers/utils/append-script.ts#90

loadNextStyleloadNextStyle

loadNextStyle(jodit, urls, i?): Promise<void>

ParametersParameters

ReturnsReturns

Promise<void>

Defined inDefined in

src/core/helpers/utils/append-script.ts#104

assertassert

assert<T>(condition, message): asserts condition

Asserts that condition is truthy (or evaluates to true).

Type parametersType parameters

ParametersParameters

ReturnsReturns

asserts condition

Defined inDefined in

src/core/helpers/utils/assert.ts#19

attrattr

attr(elm, key): null | string

Get attribute

ParametersParameters

ReturnsReturns

null | string

Defined inDefined in

src/core/helpers/utils/attr.ts#24

attr(elm, key, value): void

Remove attribute

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/attr.ts#29

attr(elm, key, value): null

Set attribute

ParametersParameters

ReturnsReturns

null

Defined inDefined in

src/core/helpers/utils/attr.ts#34

attr(elm, attributes): null

Set or remove several attributes

ParametersParameters

ReturnsReturns

null

Defined inDefined in

src/core/helpers/utils/attr.ts#43

browserbrowser

browser(browser): string | boolean

Module returns method that is used to determine the browser

ParametersParameters

ReturnsReturns

string | boolean

Example

console.log(Jodit.modules.Helpers.browser('mse'));
console.log(Jodit.modules.Helpers.browser('chrome'));
console.log($Jodit.modules.Helpers.browser('opera'));
console.log(Jodit.modules.Helpers.browser('firefox'));
console.log(Jodit.modules.Helpers.browser('mse') && Jodit.modules.Helpers.browser('version') > 10);

Defined inDefined in

src/core/helpers/utils/browser.ts#22

buildQuerybuildQuery

buildQuery(data, prefix?): string

Build query string

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/build-query.ts#17

completeUrlcompleteUrl

completeUrl(url): string

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/complete-url.ts#13

ConfigProtoConfigProto

ConfigProto(options, proto, deep?): IDictionary

ParametersParameters

ReturnsReturns

IDictionary

Example

const defaultConfig = {
  a: {
    b: {
      c: 2
    },
    e: 5
  },
  d: {
    g: 7
  }
};

const options = ConfigProto({a: {
  b: {
    c: 1
  }
}}, defaultConfig);

console.log(options.a.b.c); // 1
console.log(options.a.e); // 5
console.log(options.d.g); // 7

defaultConfig.d.g  = 8;
console.log(options.d.g); // 8

Defined inDefined in

src/core/helpers/utils/config-proto.ts#51

ConfigFlattenConfigFlatten

ConfigFlatten(obj): IDictionary

ParametersParameters

ReturnsReturns

IDictionary

Defined inDefined in

src/core/helpers/utils/config-proto.ts#102

ConfigDeepFlattenConfigDeepFlatten

ConfigDeepFlatten(obj): IDictionary

Returns a plain object from a prototype-based object.

const editor = Jodit.make('#editor', {
  image: {
    dialogWidth: 500
  }
});

console.log(editor.o.image.openOnDblClick) // true
// But you can't get all options in plain object
console.log(JSON.stringify(editor.o.image)); // {"dialogWidth":500}

const plain = Jodit.modules.Helpers.ConfigDeepFlatten(editor.o.image);
console.log(JSON.stringify(plain)); // {"dialogWidth":500, "openOnDblClick": true, "editSrc": true, ...}

ParametersParameters

ReturnsReturns

IDictionary

Defined inDefined in

src/core/helpers/utils/config-proto.ts#126

convertMediaUrlToVideoEmbedconvertMediaUrlToVideoEmbed

convertMediaUrlToVideoEmbed(url, «destructured»?): string

Javascript url pattern converter replace youtube/vimeo url in embed code.

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/convert-media-url-to-video-embed.ts#19

csscss

css(element, key): string | number

Get the value of a computed style property for the first element in the set of matched elements or set one or
more CSS properties for every matched element

ParametersParameters

ReturnsReturns

string | number

Defined inDefined in

src/core/helpers/utils/css.ts#22

css(element, key): string | number

Get the value of a computed style property for the first element in the set of matched elements or set one or
more CSS properties for every matched element

ParametersParameters

ReturnsReturns

string | number

Defined inDefined in

src/core/helpers/utils/css.ts#27

css(element, key, value): string | number

Get the value of a computed style property for the first element in the set of matched elements or set one or
more CSS properties for every matched element

ParametersParameters

ReturnsReturns

string | number

Defined inDefined in

src/core/helpers/utils/css.ts#32

css(element, key, onlyStyleMode): string | number

Get the value of a computed style property for the first element in the set of matched elements or set one or
more CSS properties for every matched element

ParametersParameters

ReturnsReturns

string | number

Defined inDefined in

src/core/helpers/utils/css.ts#38

clearCenterAlignclearCenterAlign

clearCenterAlign(image): void

Clear center align

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/css.ts#123

ctrlKeyctrlKey

ctrlKey(e): boolean

CTRL pressed

ParametersParameters

ReturnsReturns

boolean

true ctrl key was pressed

Defined inDefined in

src/core/helpers/utils/ctrl-key.ts#15

dataBinddataBind

dataBind<T>(elm, key, value?): T

Type parametersType parameters

ParametersParameters

ReturnsReturns

T

Defined inDefined in

src/core/helpers/utils/data-bind.ts#16

defaultLanguagedefaultLanguage

defaultLanguage(language?, defaultLanguage?): string

Try define user language

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/default-language.ts#17

errorerror

error(message): Error

Helper for create Error object

ParametersParameters

ReturnsReturns

Error

Defined inDefined in

src/core/helpers/utils/error/error.ts#16

connectionconnection

connection(message): Error

ParametersParameters

ReturnsReturns

Error

Defined inDefined in

src/core/helpers/utils/error/error.ts#20

optionsoptions

options(message): Error

ParametersParameters

ReturnsReturns

Error

Defined inDefined in

src/core/helpers/utils/error/error.ts#24

abortabort

abort(message?): Error

ParametersParameters

ReturnsReturns

Error

Defined inDefined in

src/core/helpers/utils/error/errors/abort-error.ts#19

isAbortisAbort

isAbort(error): error is AbortError

ParametersParameters

ReturnsReturns

error is AbortError

Deprecated

use isAbortError instead

Defined inDefined in

src/core/helpers/utils/error/errors/abort-error.ts#26

isAtomisAtom

isAtom(obj): boolean

ParametersParameters

ReturnsReturns

boolean

Defined inDefined in

src/core/helpers/utils/extend.ts#13

markAsAtomicmarkAsAtomic

markAsAtomic<T>(obj): T

Type parametersType parameters

ParametersParameters

ReturnsReturns

T

Defined inDefined in

src/core/helpers/utils/extend.ts#17

fastClonefastClone

fastClone<T>(object): T

Type parametersType parameters

ParametersParameters

ReturnsReturns

T

Defined inDefined in

src/core/helpers/utils/extend.ts#27

getClassNamegetClassName

getClassName(obj): string

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/get-class-name.ts#16

getget

get<T>(chain, obj): Nullable<T>

Safe access in tree object

Type parametersType parameters

ParametersParameters

ReturnsReturns

Nullable<T>

Example

const obj = {
  a: {
    b: {
      c: {
        e: false
      }
    }
  }
};

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

Defined inDefined in

src/core/helpers/utils/get.ts#34

humanSizeToByteshumanSizeToBytes

humanSizeToBytes(human): number

Converts from human readable file size (kb,mb,gb,tb) to bytes

ParametersParameters

ReturnsReturns

number

Defined inDefined in

src/core/helpers/utils/human-size-to-bytes.ts#15

markDeprecatedmarkDeprecated

markDeprecated(method, names?, ctx?): (...args: any[]) => void

Mark function as deprecated

ParametersParameters

ReturnsReturns

fn

(...args): void

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/mark-deprecated.ts#20

parseQueryparseQuery

parseQuery(queryString): IDictionary<string>

Parse query string

ParametersParameters

ReturnsReturns

IDictionary<string>

Defined inDefined in

src/core/helpers/utils/parse-query.ts#16

resetreset

reset<T>(key): Nullable<T>

Reset Vanilla JS native function

Type parametersType parameters

ParametersParameters

ReturnsReturns

Nullable<T>

Example

reset('Array.from')(Set([1,2,3])) // [1, 2, 3]

You must use the function derived from the method immediately as its iframe is being removed

Defined inDefined in

src/core/helpers/utils/reset.ts#27

inViewinView

inView(elm, root, doc): boolean

Check if element is in view

ParametersParameters

ReturnsReturns

boolean

Defined inDefined in

src/core/helpers/utils/scroll-into-view.ts#21

scrollIntoViewIfNeededscrollIntoViewIfNeeded

scrollIntoViewIfNeeded(elm, root, doc): void

Scroll element into view if it is not in view

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/scroll-into-view.ts#55

$$$$

$$<T>(selector, root): T[]

Type parametersType parameters

ParametersParameters

ReturnsReturns

T[]

Deprecated

Do not use it in new code

Defined inDefined in

src/core/helpers/utils/selector.ts#50

getXPathByElementgetXPathByElement

getXPathByElement(element, root): string

Calculate XPath selector

ParametersParameters

ReturnsReturns

string

Defined inDefined in

src/core/helpers/utils/selector.ts#94

refsrefs

refs<T>(root): IDictionary<T>

Find all ref or data-ref elements inside HTMLElement

Type parametersType parameters

ParametersParameters

ReturnsReturns

IDictionary<T>

Defined inDefined in

src/core/helpers/utils/selector.ts#128

cssPathcssPath

cssPath(el): Nullable<string>

Calculate full CSS selector

ParametersParameters

ReturnsReturns

Nullable<string>

Defined inDefined in

src/core/helpers/utils/selector.ts#150

resolveElementresolveElement

resolveElement(element, od): HTMLElement

Try to find element by selector

ParametersParameters

ReturnsReturns

HTMLElement

Defined inDefined in

src/core/helpers/utils/selector.ts#192

setset

set<T>(chain, value, obj): void

Safe access in tree object

Type parametersType parameters

ParametersParameters

ReturnsReturns

void

Example

const a = {}, b = {};
Jodit.modules.Helpers.set('a.b.c.d.e', 1, a);
console.log(a);// {a: {b: {c: {d: {e: 1}}}}}

Jodit.modules.Helpers.set('a.0.e', 1, b);
console.log(b);// {a: [{e: 1}]}

Defined inDefined in

src/core/helpers/utils/set.ts#30

callcall

call<T, R>(func, ...args): R

Call function with parameters

Type parametersType parameters

ParametersParameters

ReturnsReturns

R

Example

const f = Math.random();
Jodit.modules.Helpers.call(f > 0.5 ? Math.ceil : Math.floor, f);

Defined inDefined in

src/core/helpers/utils/utils.ts#35

markOwnermarkOwner

markOwner(jodit, elm): void

Mark element for debugging

ParametersParameters

ReturnsReturns

void

Defined inDefined in

src/core/helpers/utils/utils.ts#45

callPromisecallPromise

callPromise(condition, callback?): CanPromise<void>

ParametersParameters

ReturnsReturns

CanPromise<void>

Defined inDefined in

src/core/helpers/utils/utils.ts#54

loadImageloadImage

loadImage(src, jodit): RejectablePromise<HTMLImageElement>

Allow load image in promise

ParametersParameters

ReturnsReturns

RejectablePromise<HTMLImageElement>

Defined inDefined in

src/core/helpers/utils/utils.ts#73

keyskeys

keys(obj, own?): string[]

ParametersParameters

ReturnsReturns

string[]

Defined inDefined in

src/core/helpers/utils/utils.ts#100

memorizeExecmemorizeExec

memorizeExec<T>(editor, _, «destructured», preProcessValue?): false | void

Memorize last user chose

Type parametersType parameters

ParametersParameters

ReturnsReturns

false | void

Defined inDefined in

src/core/helpers/utils/utils.ts#117

getDataTransfergetDataTransfer

getDataTransfer(event): Nullable<DataTransfer>

Get DataTransfer from different event types

ParametersParameters

ReturnsReturns

Nullable<DataTransfer>

Defined inDefined in

jodit/src/core/helpers/utils/utils.ts:143

previewBoxpreviewBox

previewBox(editor, defaultValue?, points?, container?): [HTMLElement, () => void]

Generates a copy of an HTML document, resizes images, executes JS

beforePreviewBox(string | undefined, 'pt' | 'px' | '')
afterPreviewBox(HTMLElement)

ParametersParameters

ReturnsReturns

[HTMLElement, () => void]

Defined inDefined in

jodit/src/core/helpers/utils/print.ts:71