Jodit Editor

IJodit

types.IJodit

Hierarchy

Implemented by

isJodit

Readonly isJodit: true

Defined in

src/types/jodit.d.ts#41

options

Readonly options: Config

Overrides

IViewWithToolbar.options

Defined in

src/types/jodit.d.ts#43

history

Readonly history: IHistory

Defined in

src/types/jodit.d.ts#45

editor

editor: HTMLElement

Defined in

src/types/jodit.d.ts#47

element

Readonly element: HTMLElement

Defined in

src/types/jodit.d.ts#48

places

Readonly places: IWorkPlace[]

Defined in

src/types/jodit.d.ts#74

currentPlace

Readonly currentPlace: IWorkPlace

Defined in

src/types/jodit.d.ts#75

value

value: string

Defined in

src/types/jodit.d.ts#79

text

Readonly text: string

Defined in

src/types/jodit.d.ts#80

editorDocument

Readonly editorDocument: HTMLDocument

Defined in

src/types/jodit.d.ts#82

ed

Readonly ed: HTMLDocument

Alias for this.ed

Defined in

src/types/jodit.d.ts#89

editorWindow

editorWindow: Window

Defined in

src/types/jodit.d.ts#91

ew

Readonly ew: Window

Alias for this.ed

Defined in

src/types/jodit.d.ts#96

createInside

Readonly createInside: ICreate

Defined in

src/types/jodit.d.ts#98

selection

Readonly selection: ISelect

Defined in

src/types/jodit.d.ts#100

s

Readonly s: ISelect

Alias for this.selection

Defined in

src/types/jodit.d.ts#105

mode

Readonly mode: Modes

Defined in

src/types/jodit.d.ts#120

editorIsActive

Readonly editorIsActive: boolean

Defined in

src/types/jodit.d.ts#124

isFocused

Readonly isFocused: boolean

Defined in

src/types/jodit.d.ts#127

workplace

Readonly workplace: HTMLDivElement

workplace It contains source and wysiwyg editors

Defined in

src/types/jodit.d.ts#163

statusbar

Readonly statusbar: IStatusBar

Defined in

src/types/jodit.d.ts#165

uploader

Readonly uploader: IUploader

Defined in

src/types/jodit.d.ts#167

filebrowser

Readonly filebrowser: IFileBrowser<IFileBrowserOptions>

Defined in

src/types/jodit.d.ts#168

iframe

Optional iframe: void | HTMLIFrameElement

Defined in

src/types/jodit.d.ts#170

mods

mods: IDictionary<ModType>

Inherited from

IViewWithToolbar.mods

Defined in

src/types/traits.d.ts#28

container

container: HTMLElement

Inherited from

IViewWithToolbar.container

Defined in

src/types/types.d.ts#42

async

Readonly async: IAsync

Inherited from

IViewWithToolbar.async

Defined in

src/types/types.d.ts#46

ownerDocument

Readonly ownerDocument: Document

Inherited from

IViewWithToolbar.ownerDocument

Defined in

src/types/types.d.ts#47

od

Readonly od: Document

Inherited from

IViewWithToolbar.od

Defined in

src/types/types.d.ts#48

ownerWindow

Readonly ownerWindow: Window

Inherited from

IViewWithToolbar.ownerWindow

Defined in

src/types/types.d.ts#49

ow

Readonly ow: Window

Inherited from

IViewWithToolbar.ow

Defined in

src/types/types.d.ts#50

componentName

Readonly componentName: string

Inherited from

IViewWithToolbar.componentName

Defined in

src/types/types.d.ts#54

uid

Readonly uid: string

Inherited from

IViewWithToolbar.uid

Defined in

src/types/types.d.ts#65

isDestructed

Readonly isDestructed: boolean

Inherited from

IViewWithToolbar.isDestructed

Defined in

src/types/types.d.ts#66

isInDestruct

Readonly isInDestruct: boolean

Inherited from

IViewWithToolbar.isInDestruct

Defined in

src/types/types.d.ts#67

isReady

Readonly isReady: boolean

Inherited from

IViewWithToolbar.isReady

Defined in

src/types/types.d.ts#68

componentStatus

Readonly componentStatus: ComponentStatus

Inherited from

IViewWithToolbar.componentStatus

Defined in

src/types/types.d.ts#70

isView

Readonly isView: true

Inherited from

IViewWithToolbar.isView

Defined in

src/types/view.d.ts#108

parent

Readonly parent: Nullable<IViewBased<IViewOptions>>

Inherited from

IViewWithToolbar.parent

Defined in

src/types/view.d.ts#109

id

Readonly id: string

ID attribute for a source element, id add {id}_editor it's editor's id

Inherited from

IViewWithToolbar.id

Defined in

src/types/view.d.ts#114

basePath

Readonly basePath: string

Inherited from

IViewWithToolbar.basePath

Defined in

src/types/view.d.ts#116

isLocked

Readonly isLocked: boolean

Inherited from

IViewWithToolbar.isLocked

Defined in

src/types/view.d.ts#118

isFullSize

Readonly isFullSize: boolean

Inherited from

IViewWithToolbar.isFullSize

Defined in

src/types/view.d.ts#123

buffer

Readonly buffer: IStorage<StorageValueType>

Inherited from

IViewWithToolbar.buffer

Defined in

src/types/view.d.ts#126

storage

Readonly storage: IStorage<StorageValueType>

Inherited from

IViewWithToolbar.storage

Defined in

src/types/view.d.ts#127

progressbar

Readonly progressbar: IProgressBar

Inherited from

IViewWithToolbar.progressbar

Defined in

src/types/view.d.ts#129

events

Readonly events: IEventEmitter

Inherited from

IViewWithToolbar.events

Defined in

src/types/view.d.ts#131

e

Readonly e: IEventEmitter

Inherited from

IViewWithToolbar.e

Defined in

src/types/view.d.ts#132

create

Readonly create: ICreate

Inherited from

IViewWithToolbar.create

Defined in

src/types/view.d.ts#134

c

Readonly c: ICreate

Inherited from

IViewWithToolbar.c

Defined in

src/types/view.d.ts#135

OPTIONS

Readonly OPTIONS: IViewOptions

Inherited from

IViewWithToolbar.OPTIONS

Defined in

src/types/view.d.ts#137

o

Readonly o: Config

Inherited from

IViewWithToolbar.o

Defined in

src/types/view.d.ts#140

defaultTimeout

Readonly defaultTimeout: number

Inherited from

IViewWithToolbar.defaultTimeout

Defined in

src/types/view.d.ts#144

components

Readonly components: Set<IComponent<IViewBased<IViewOptions>>>

Inherited from

IViewWithToolbar.components

Defined in

src/types/view.d.ts#148

message

Readonly message: IMessages

Inherited from

IViewWithToolbar.message

Defined in

src/types/view.d.ts#152

toolbar

toolbar: IToolbarCollection

Inherited from

IViewWithToolbar.toolbar

Defined in

src/types/view.d.ts#156

toolbarContainer

toolbarContainer: HTMLElement

Inherited from

IViewWithToolbar.toolbarContainer

Defined in

src/types/view.d.ts#157

registeredButtons

registeredButtons: Set<IPluginButton>

Inherited from

IViewWithToolbar.registeredButtons

Defined in

src/types/view.d.ts#159

getNativeEditorValue

getNativeEditorValue(): string

Returns

string

Defined in

src/types/jodit.d.ts#50

getEditorValue

getEditorValue(removeSelectionMarkers?, consumer?): string

Parameters

Name Type
removeSelectionMarkers? boolean
consumer? string

Returns

string

Defined in

src/types/jodit.d.ts#51

setEditorValue

setEditorValue(value?): void

Parameters

Name Type
value? string

Returns

void

Defined in

src/types/jodit.d.ts#52

getElementValue

getElementValue(): string

Only getter

Returns

string

Defined in

src/types/jodit.d.ts#69

getReadOnly

getReadOnly(): boolean

Returns

boolean

Defined in

src/types/jodit.d.ts#71

setReadOnly

setReadOnly(enable): void

Parameters

Name Type
enable boolean

Returns

void

Defined in

src/types/jodit.d.ts#72

addPlace

addPlace(source, options?): void

Parameters

Name Type
source string | HTMLElement
options? IViewOptions

Returns

void

Defined in

src/types/jodit.d.ts#76

setCurrentPlace

setCurrentPlace(place): void

Parameters

Name Type
place IWorkPlace

Returns

void

Defined in

src/types/jodit.d.ts#77

waitForReady

waitForReady(): Promise<IJodit>

Returns

Promise<IJodit>

Defined in

src/types/jodit.d.ts#84

getRealMode

getRealMode(): Modes

Return current real work mode. When editor in MODE_SOURCE or MODE_WYSIWYG it will
return them, but then editor in MODE_SPLIT it will return MODE_SOURCE if
Textarea(CodeMirror) focused or MODE_WYSIWYG otherwise

Returns

Modes

Example

var editor = Jodit.make('#editor');
console.log(editor.getRealMode());
Defined in

src/types/jodit.d.ts#118

getMode

getMode(): Modes

Returns

Modes

Defined in

src/types/jodit.d.ts#119

isEditorMode

isEditorMode(): boolean

Returns

boolean

Defined in

src/types/jodit.d.ts#121

toggleMode

toggleMode(): void

Returns

void

Defined in

src/types/jodit.d.ts#122

focus

focus(): void

Returns

void

Defined in

src/types/jodit.d.ts#126

fetch

fetch<Response>(url, options?): Promise<IResponse<Response>>

Type parameters

Name Type
Response extends object = any

Parameters

Name Type
url string
options? Partial<AjaxOptions>

Returns

Promise<IResponse<Response>>

Defined in

src/types/jodit.d.ts#129

execCommand

execCommand(command, showUI?, value?, ...args): any

Parameters

Name Type
command string
showUI? any
value? any
...args unknown[]

Returns

any

Defined in

src/types/jodit.d.ts#134

nativeExecCommand

nativeExecCommand(command, showUI?, value?): boolean

Parameters

Name Type
command string
showUI? any
value? any

Returns

boolean

Defined in

src/types/jodit.d.ts#140

registerCommand

registerCommand<C>(commandNameOriginal, command, options?): IJodit

Type parameters

Name Type
C extends string

Parameters

Name Type
commandNameOriginal C
command CustomCommand<IJodit, C>
options? Object
options.stopPropagation boolean

Returns

IJodit

Defined in

src/types/jodit.d.ts#146

registerHotkeyToCommand

registerHotkeyToCommand(hotkeys, commandName, shouldStop?): void

Parameters

Name Type
hotkeys string | string[]
commandName string
shouldStop? boolean

Returns

void

Defined in

src/types/jodit.d.ts#154

setMod

setMod<T>(this, name, value): T

Set/remove modification (null - remove)

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IMods

Parameters

Name Type
this T
name string
value ModType

Returns

T

Inherited from

IViewWithToolbar.setMod

Defined in

src/types/traits.d.ts#20

afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Inherited from

IViewWithToolbar.afterSetMod

Defined in

src/types/traits.d.ts#25

getMod

getMod(name): ModType

Parameters

Name Type
name string

Returns

ModType

Inherited from

IViewWithToolbar.getMod

Defined in

src/types/traits.d.ts#27

getElm

getElm(elementName): Nullable<HTMLElement>

Parameters

Name Type
elementName string

Returns

Nullable<HTMLElement>

Inherited from

IViewWithToolbar.getElm

Defined in

src/types/traits.d.ts#32

getElms

getElms(elementName): HTMLElement[]

Parameters

Name Type
elementName string

Returns

HTMLElement[]

Inherited from

IViewWithToolbar.getElms

Defined in

src/types/traits.d.ts#33

dlg

dlg(options?): IDialog

Parameters

Name Type
options? IDialogOptions

Returns

IDialog

Inherited from

IDlgs.dlg

Defined in

src/types/traits.d.ts#37

confirm

confirm(msg, title, callback?): IDialog

Parameters

Name Type
msg string
title undefined | string | (yes: boolean) => void
callback? (yes: boolean) => false | void

Returns

IDialog

Inherited from

IDlgs.confirm

Defined in

src/types/traits.d.ts#39

prompt

prompt(msg, title, callback, placeholder?, defaultValue?): IDialog

Parameters

Name Type
msg string
title undefined | string | () => false | void
callback (value: string) => false | void
placeholder? string
defaultValue? string

Returns

IDialog

Inherited from

IDlgs.prompt

Defined in

src/types/traits.d.ts#45

alert

alert(msg, title?, callback?, className?): IDialog

Parameters

Name Type
msg string | HTMLElement
title? string | () => false | void
callback? string | (dialog: IDialog) => false | void
className? string

Returns

IDialog

Inherited from

IDlgs.alert

Defined in

src/types/traits.d.ts#53

destruct

destruct(jodit?): any

Parameters

Name Type
jodit? IViewBased<IViewOptions>

Returns

any

Inherited from

IViewWithToolbar.destruct

Defined in

src/types/types.d.ts#32

get

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

Type parameters

Name
T

Parameters

Name Type
chain string
obj? IDictionary<any, string>

Returns

Nullable<T>

Inherited from

IViewWithToolbar.get

Defined in

src/types/types.d.ts#52

className

className(): string

Returns

string

Inherited from

IViewWithToolbar.className

Defined in

src/types/types.d.ts#55

getFullElName

getFullElName(elementName): string

Parameters

Name Type
elementName string

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#57

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#58

getFullElName(elementName, mod?, modValue?): string

Parameters

Name Type
elementName string
mod? string
modValue? string | boolean

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#59

setStatus

setStatus(componentStatus): void

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Inherited from

IViewWithToolbar.setStatus

Defined in

src/types/types.d.ts#71

hookStatus

hookStatus(status, callback): void

Parameters

Name Type
status ComponentStatus
callback (component: this) => void

Returns

void

Inherited from

IViewWithToolbar.hookStatus

Defined in

src/types/types.d.ts#73

bindDestruct

bindDestruct(component): this

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Inherited from

IViewWithToolbar.bindDestruct

Defined in

src/types/types.d.ts#78

isLockedNotBy

isLockedNotBy(name): boolean

Parameters

Name Type
name string

Returns

boolean

Inherited from

IViewWithToolbar.isLockedNotBy

Defined in

src/types/view.d.ts#119

lock

lock(name?): boolean

Parameters

Name Type
name? string

Returns

boolean

Inherited from

IViewWithToolbar.lock

Defined in

src/types/view.d.ts#120

unlock

unlock(): boolean

Returns

boolean

Inherited from

IViewWithToolbar.unlock

Defined in

src/types/view.d.ts#121

toggleFullSize

toggleFullSize(isFullSize?): void

Parameters

Name Type
isFullSize? boolean

Returns

void

Inherited from

IViewWithToolbar.toggleFullSize

Defined in

src/types/view.d.ts#124

i18n

i18n(text, ...params): string

Parameters

Name Type
text string
...params (string | number)[]

Returns

string

Inherited from

IViewWithToolbar.i18n

Defined in

src/types/view.d.ts#142

getVersion

getVersion(): string

Returns

string

Inherited from

IViewWithToolbar.getVersion

Defined in

src/types/view.d.ts#146

getInstance

getInstance<T>(module, options?): T

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>>

Parameters

Name Type
module Function
options? object

Returns

T

Inherited from

IViewWithToolbar.getInstance

Defined in

src/types/view.d.ts#149

getInstance<T>(moduleName, options?): T

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>>

Parameters

Name Type
moduleName string
options? object

Returns

T

Inherited from

IViewWithToolbar.getInstance

Defined in

src/types/view.d.ts#150

registerButton

registerButton(btn): this

Parameters

Name Type
btn IPluginButton

Returns

this

Inherited from

IViewWithToolbar.registerButton

Defined in

src/types/view.d.ts#160

unregisterButton

unregisterButton(btn): this

Parameters

Name Type
btn IPluginButton

Returns

this

Inherited from

IViewWithToolbar.unregisterButton

Defined in

src/types/view.d.ts#161

getRegisteredButtonGroups

getRegisteredButtonGroups(): IDictionary<string[]>

Returns

IDictionary<string[]>

Inherited from

IViewWithToolbar.getRegisteredButtonGroups

Defined in

src/types/view.d.ts#162

setPanel

setPanel(element): void

Parameters

Name Type
element string | HTMLElement

Returns

void

Inherited from

IViewWithToolbar.setPanel

Defined in

jodit/src/types/view.d.ts:164

In this article: