Jodit Editor

Module: types

Classes

Interfaces

Attributes

Attributes: IDictionary<string | number | boolean | undefined | IDictionary<string | number | boolean | undefined>>

Defined in

src/types/create.d.ts#13

BooleanFunction

BooleanFunction<T>: (this: T, ...args: any[]) => boolean

Type parameters

Name Type
T any

Type declaration

(this, ...args): boolean

Parameters
Name Type
this T
...args any[]
Returns

boolean

Defined in

src/types/types.d.ts#158

BuildDataResult

BuildDataResult: FormData | IDictionary<string> | Promise<FormData | IDictionary<string>> | string

Defined in

src/types/uploader.d.ts#32

ButtonGroup

ButtonGroup: string | "source" | "font-style" | "script" | "list" | "indent" | "font" | "color" | "media" | "state" | "clipboard" | "insert" | "history" | "search" | "other" | "info"

Defined in

src/types/toolbar.d.ts#304

ButtonVariant

ButtonVariant: "initial" | "default" | "primary" | "secondary" | "success" | "danger"

Defined in

src/types/ui.d.ts#53

Buttons

Buttons: (string | IControlType)[]

Defined in

src/types/toolbar.d.ts#302

ButtonsGroups

ButtonsGroups: (IControlType | string | ButtonsGroup)[]

Defined in

src/types/toolbar.d.ts#327

ButtonsOption

ButtonsOption: string | ButtonsGroups

Defined in

src/types/toolbar.d.ts#328

CanArray

CanArray<T>: T | T[]

Type parameters

Name
T

Defined in

src/types/types.d.ts#24

CanPromise

CanPromise<T>: T | Promise<T>

Type parameters

Name
T

Defined in

src/types/types.d.ts#22

CanUndef

CanUndef<T>: T | undefined

Type parameters

Name
T

Defined in

src/types/types.d.ts#23

Children

Children: string | (string | Node)[] | Node

Defined in

src/types/create.d.ts#20

CommitMode

CommitMode: "initial" | "wrap" | "unwrap" | "change" | "unset" | "replace"

Defined in

src/types/style.d.ts#87

ComponentStatus

ComponentStatus: "beforeInit" | "ready" | "beforeDestruct" | "destructed"

Defined in

src/types/types.d.ts#35

Content

Content: ContentItem | ContentItem[] | (ContentItem | ContentItem[])[]

Defined in

src/types/dialog.d.ts#26

ContentItem

ContentItem: string | HTMLElement | IContainer

Defined in

src/types/dialog.d.ts#25

CustomCommand

CustomCommand<T, C>: ICommandType<T, C> | ExecCommandCallback<T, C>

Type parameters

Name Type
T T
C extends string

Defined in

src/types/types.d.ts#181

DataVariant

DataVariant: IDictionary<string> | null | FormData | string | IDictionary<string | IDictionary>

Defined in

src/types/ajax.d.ts#13

DecoratorHandler

DecoratorHandler: <T>(target: T, propertyKey: string) => void | PropertyDescriptor

Type declaration

<T>(target, propertyKey): void | PropertyDescriptor

Type parameters
Name Type
T extends IComponent & IDictionary
Parameters
Name Type
target T
propertyKey string
Returns

void | PropertyDescriptor

Defined in

src/types/core.d.ts#13

ExecCommandCallback

ExecCommandCallback<T, C>: (this: T, command: C, value?: string, next?: any, ...args: unknown[]) => void | boolean | Promise<void | boolean> | (this: T, command: C, value: string, next: string, ...args: unknown[]) => void | boolean | Promise<void | boolean>

Type parameters

Name Type
T T
C extends string

Defined in

src/types/types.d.ts#160

HTMLTagNames

HTMLTagNames: Prettify<keyof HTMLElementTagNameMap>

Defined in

src/types/types.d.ts#296

HandlerError

HandlerError: (e: Error) => void

Type declaration

(e): void

Parameters
Name Type
e Error
Returns

void

Defined in

src/types/uploader.d.ts#31

HandlerSuccess

HandlerSuccess: (resp: IUploaderData) => void

Type declaration

(resp): void

Parameters
Name Type
resp IUploaderData
Returns

void

Defined in

src/types/uploader.d.ts#30

IAttributes

IAttributes: { [K in string]: IStyle | string | number | boolean | null }

Defined in

src/types/style.d.ts#17

IControlTypeStrongList

IControlTypeStrongList: RequireKeys<IControlTypeStrong, "list">

Defined in

src/types/toolbar.d.ts#333

IDictionary

IDictionary<T, K>: { [key in K]: T }

Type parameters

Name Type
T any
K extends string = string

Defined in

src/types/types.d.ts#14

IFileBrowserItem

IFileBrowserItem: IFileBrowserItemWrapper & IFileBrowserItemElement

Defined in

src/types/file-browser.d.ts#345

ISourcesFiles

ISourcesFiles: ISource[]

Defined in

src/types/file-browser.d.ts#50

IStyle

IStyle: IDictionary<StyleValue>

Defined in

src/types/style.d.ts#16

ITimeout

ITimeout: number | () => number

Defined in

src/types/async.d.ts#14

IUIButtonStatePartial

IUIButtonStatePartial: Omit<Partial<IUIButtonState>, "icon"> & { icon?: Partial<IUIButtonState["icon"]> }

Defined in

src/types/ui.d.ts#80

ImageAction

ImageAction: "resize" | "crop"

Defined in

src/types/types.d.ts#265

ImageHAlign

ImageHAlign: "normal" | "left" | "right" | "center" | ""

Defined in

src/types/types.d.ts#266

InsertMode

InsertMode: "insert_as_html" | "insert_as_text" | "insert_clear_html" | "insert_only_text"

Defined in

src/types/types.d.ts#259

MessageVariant

MessageVariant: "info" | "error" | "success"

Defined in

src/types/messages.d.ts#13

ModType

ModType: string | boolean | null

Defined in

src/types/traits.d.ts#14

Modes

Modes: 1 | 2 | 3

Defined in

src/types/types.d.ts#298

NodeCondition

NodeCondition<T>: (node: Nullable<T>) => boolean | null | false | void | ""

Type parameters

Name Type
T extends Node = Node

Type declaration

(node): boolean | null | false | void | ""

Parameters
Name Type
node Nullable<T>
Returns

boolean | null | false | void | ""

Defined in

src/types/types.d.ts#89

NodeFunction

NodeFunction: (elm: HTMLElement) => void

Type declaration

(elm): void

Parameters
Name Type
elm HTMLElement
Returns

void

Defined in

src/types/view.d.ts#60

Nullable

Nullable<T>: T | null

Type parameters

Name
T

Defined in

src/types/types.d.ts#25

PluginInstance

PluginInstance: IPlugin | object

Defined in

src/types/plugin.d.ts#57

PluginType

PluginType: typeof IPlugin | IPlugin | PluginFunction | Function

Defined in

src/types/plugin.d.ts#56

PopupStrategy

PopupStrategy: "leftBottom" | "rightBottom" | "leftTop" | "rightTop"

Defined in

src/types/popup.d.ts#14

Prettify

Prettify<T>: { [P in keyof T]: T[P] }

Type parameters

Name
T

Defined in

src/types/types.d.ts#18

RequireKeys

RequireKeys<T, K>: Required<Pick<T, K>> & Omit<T, K>

Type parameters

Name Type
T extends object
K extends keyof T

Defined in

src/types/toolbar.d.ts#330

StorageValueType

StorageValueType: string | number | boolean | object | StorageValueType[]

Defined in

src/types/storage.d.ts#11

StyleValue

StyleValue: number | string | null | undefined

Defined in

src/types/style.d.ts#14

WindowSelection

WindowSelection: Selection

Defined in

src/types/select.d.ts#22

content

Const content: string

Defined in

src/typings.d.ts#12

In this article: