IJodit | Jodit Editor

Hierarchy

IViewWithToolbar
IDlgs
- IJodit

Implemented by

Jodit

Index

Properties

`Readonly` OPTIONS

OPTIONS: IViewOptions

`Readonly` async

async: IAsync

`Readonly` basePath

basePath: string

`Readonly` buffer

buffer: IStorage<StorageValueType>

`Readonly` c

c: ICreate

`Readonly` componentName

componentName: string

`Readonly` componentStatus

componentStatus: ComponentStatus

`Readonly` components

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

container

container: HTMLElement

`Readonly` create

create: ICreate

createInside

createInside: ICreate

currentPlace

currentPlace: IWorkPlace

`Readonly` defaultTimeout

defaultTimeout: number

`Readonly` e

e: IEventEmitter

ed

ed: HTMLDocument

Alias for this.ed

editor

editor: HTMLElement

editorDocument

editorDocument: HTMLDocument

editorIsActive

editorIsActive: boolean

editorWindow

editorWindow: Window

Alias for this.ed

filebrowser

filebrowser: IFileBrowser<IFileBrowserOptions>

history

history: IHistory

`Readonly` id

id: string

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

`Optional` iframe

iframe?: void | HTMLIFrameElement

`Readonly` isDestructed

isDestructed: boolean

`Readonly` isFocused

isFocused: boolean

`Readonly` isFullSize

isFullSize: boolean

`Readonly` isInDestruct

isInDestruct: boolean

isJodit

isJodit: true

`Readonly` isLocked

isLocked: boolean

`Readonly` isReady

isReady: boolean

`Readonly` isView

isView: true

message

message: IMessages

mode

mode: Modes

mods

mods: IDictionary<ModType, string>

`Readonly` o

o: Config

observer

observer: IHistory

Deprecated

Instead use Jodit.history

`Readonly` od

od: Document

options

options: Config

`Readonly` ow

ow: Window

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` ownerWindow

ownerWindow: Window

`Readonly` parent

parent: Nullable<IViewBased<IViewOptions>>

places

places: IWorkPlace[]

`Readonly` progressbar

progressbar: IProgressBar

registeredButtons

registeredButtons: Set<IPluginButton>

s

s: ISelect

Alias for this.selection

selection

selection: ISelect

statusbar

statusbar: IStatusBar

`Readonly` storage

storage: IStorage<StorageValueType>

text

text: string

toolbar

toolbar: IToolbarCollection

toolbarContainer

toolbarContainer: HTMLElement

`Readonly` uid

uid: string

uploader

uploader: IUploader

value

value: string

workplace

workplace: HTMLDivElement

workplace It contains source and wysiwyg editors

Methods

addPlace

addPlace(source: string | HTMLElement, options?: IViewOptions): void
Parameters
- source: string | HTMLElement
- Optional options: IViewOptions
Returns void

afterSetMod

afterSetMod(name: string, value: ModType): void
Parameters
- name: string
- value: ModType
Returns void

alert

alert(msg: string | HTMLElement, title?: string | (() => false | void), callback?: string | ((dialog: IDialog) => false | void), className?: string): IDialog
Parameters
- msg: string | HTMLElement
- Optional title: string | (() => false | void)
- Optional callback: string | ((dialog: IDialog) => false | void)
- Optional className: string
Returns IDialog

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): IJodit
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns IJodit

className

className(): string
Returns string

confirm

confirm(msg: string, title: undefined | string | ((yes: boolean) => void), callback?: ((yes: boolean) => false | void)): IDialog
Parameters
- msg: string
- title: undefined | string | ((yes: boolean) => void)
- Optional callback: ((yes: boolean) => false | void)
  - - (yes: boolean): false | void
    - Parameters
      
      yes: boolean
      
      Returns false | void
Returns IDialog

destruct

destruct(jodit?: IViewBased<IViewOptions>): any
Parameters
- Optional jodit: IViewBased<IViewOptions>
Returns any

dlg

dlg(options?: IDialogOptions): IDialog
Parameters
- Optional options: IDialogOptions
Returns IDialog

execCommand

execCommand(command: string, showUI?: any, value?: any, ...args: unknown[]): any
Parameters
- command: string
- Optional showUI: any
- Optional value: any
- Rest ...args: unknown[]
Returns any

fetch

fetch<Response>(url: string, options?: Partial<AjaxOptions>): Promise<IResponse<Response>>
Type Parameters
- Response extends object = any
Parameters
- url: string
- Optional options: Partial<AjaxOptions>
Returns Promise<IResponse<Response>>

focus

focus(): void
Returns void

get

get<T>(chain: string, obj?: IDictionary<any, string>): Nullable<T>
Type Parameters
- T
Parameters
- chain: string
- Optional obj: IDictionary<any, string>
Returns Nullable<T>

getEditorValue

getEditorValue(removeSelectionMarkers?: boolean, consumer?: string): string
Parameters
- Optional removeSelectionMarkers: boolean
- Optional consumer: string
Returns string

getElementValue

getElementValue(): string
Only getter

Returns string

getElm

getElm(elementName: string): Nullable<HTMLElement>
Parameters
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms(elementName: string): HTMLElement[]
Parameters
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Parameters
- elementName: string
Returns string
getFullElName(elementName: string, mod: string): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName: string, mod?: string, modValue?: string | boolean): string
Parameters
- elementName: string
- Optional mod: string
- Optional modValue: string | boolean
Returns string

getInstance

getInstance<T>(moduleName: string, options?: object): T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T>
Parameters
- moduleName: string
- Optional options: object
Returns T

getMod

getMod(name: string): ModType
Parameters
- name: string
Returns ModType

getMode

getMode(): Modes
Returns Modes

getNativeEditorValue

getNativeEditorValue(): string
Returns string

getReadOnly

getReadOnly(): boolean
Returns boolean

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

Example
```
var editor = Jodit.make('#editor');
console.log(editor.getRealMode());
```
Returns Modes

getRegisteredButtonGroups

getRegisteredButtonGroups(): IDictionary<string[], string>
Returns IDictionary<string[], string>

getVersion

getVersion(): string
Returns string

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: IJodit) => void)): void
Parameters
- status: ComponentStatus
- callback: ((component: IJodit) => void)
  - - (component: IJodit): void
    - Parameters
      
      component: IJodit
      
      Returns void
Returns void

i18n

i18n(text: string, ...params: (string | number)[]): string
Parameters
- text: string
- Rest ...params: (string | number)[]
Returns string

isEditorMode

isEditorMode(): boolean
Returns boolean

isLockedNotBy

isLockedNotBy(name: string): boolean
Parameters
- name: string
Returns boolean

lock

lock(name?: string): boolean
Parameters
- Optional name: string
Returns boolean

nativeExecCommand

nativeExecCommand(command: string, showUI?: any, value?: any): boolean
Parameters
- command: string
- Optional showUI: any
- Optional value: any
Returns boolean

prompt

prompt(msg: string, title: undefined | string | (() => false | void), callback: ((value: string) => false | void), placeholder?: string, defaultValue?: string): IDialog
Parameters
- msg: string
- title: undefined | string | (() => false | void)
- callback: ((value: string) => false | void)
  - - (value: string): false | void
    - Parameters
      
      value: string
      
      Returns false | void
- Optional placeholder: string
- Optional defaultValue: string
Returns IDialog

registerButton

registerButton(btn: IPluginButton): IJodit
Parameters
- btn: IPluginButton
Returns IJodit

registerCommand

registerCommand<C>(commandNameOriginal: C, command: CustomCommand<IJodit, C>, options?: {
stopPropagation: boolean;
}): IJodit
Type Parameters
- C extends string
Parameters
- commandNameOriginal: C
- command: CustomCommand<IJodit, C>
- Optional options: {
  stopPropagation: boolean;
  }
  - stopPropagation: boolean
Returns IJodit

registerHotkeyToCommand

registerHotkeyToCommand(hotkeys: string | string[], commandName: string, shouldStop?: boolean): void
Parameters
- hotkeys: string | string[]
- commandName: string
- Optional shouldStop: boolean
Returns void

setCurrentPlace

setCurrentPlace(place: IWorkPlace): void
Parameters
- place: IWorkPlace
Returns void

setEditorValue

setEditorValue(value?: string): void
Parameters
- Optional value: string
Returns void

setMod

setMod<T>(this: T, name: string, value: ModType): T
Set/remove modification (null - remove)
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
Returns T

setPanel

setPanel(element: string | HTMLElement): void
Parameters
- element: string | HTMLElement
Returns void

setReadOnly

setReadOnly(enable: boolean): void
Parameters
- enable: boolean
Returns void

setStatus

setStatus(componentStatus: ComponentStatus): void
Parameters
- componentStatus: ComponentStatus
Returns void

toggleFullSize

toggleFullSize(isFullSize?: boolean): void
Parameters
- Optional isFullSize: boolean
Returns void

toggleMode

toggleMode(): void
Returns void

unlock

unlock(): boolean
Returns boolean

unregisterButton

unregisterButton(btn: IPluginButton): IJodit
Parameters
- btn: IPluginButton
Returns IJodit

waitForReady

waitForReady(): Promise<IJodit>
Returns Promise<IJodit>

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly OPTIONS

Readonly async

Readonly basePath

Readonly buffer

Readonly c

Readonly componentName

Readonly componentStatus

Readonly components

container

Readonly create

createInside

currentPlace

Readonly defaultTimeout

Readonly e

ed

editor

editorDocument

editorIsActive

editorWindow

element

Readonly events

ew

filebrowser

history

Readonly id

Optional iframe

Readonly isDestructed

Readonly isFocused

Readonly isFullSize

Readonly isInDestruct

isJodit

Readonly isLocked

Readonly isReady

Readonly isView

message

mode

mods

Readonly o

observer

Deprecated

Readonly od

options

Readonly ow

Readonly ownerDocument

Readonly ownerWindow

Readonly parent

places

Readonly progressbar

registeredButtons

s

selection

statusbar

Readonly storage

text

toolbar

toolbarContainer

Readonly uid

uploader

value

workplace

Methods

addPlace

Parameters

source: string | HTMLElement

Optional options: IViewOptions

Returns void

afterSetMod

Parameters

name: string

value: ModType

Returns void

alert

Parameters

msg: string | HTMLElement

`Readonly` OPTIONS

`Readonly` async

`Readonly` basePath

`Readonly` buffer

`Readonly` c

`Readonly` componentName

`Readonly` componentStatus

`Readonly` components

`Readonly` create

`Readonly` defaultTimeout

`Readonly` e

`Readonly` events

`Readonly` id

`Optional` iframe

`Readonly` isDestructed

`Readonly` isFocused

`Readonly` isFullSize

`Readonly` isInDestruct

`Readonly` isLocked

`Readonly` isReady

`Readonly` isView

`Readonly` o

`Readonly` od

`Readonly` ow

`Readonly` ownerDocument

`Readonly` ownerWindow

`Readonly` parent

`Readonly` progressbar

`Readonly` storage

`Readonly` uid

`Optional` options: IViewOptions

`Optional` title: string | (() => false | void)

`Optional` callback: string | ((dialog: IDialog) => false | void)

`Optional` className: string

`Optional` callback: ((yes: boolean) => false | void)

`Optional` jodit: IViewBased<IViewOptions>

`Optional` options: IDialogOptions

`Optional` showUI: any

`Optional` value: any

`Rest` ...args: unknown[]

`Optional` options: Partial<AjaxOptions>

`Optional` obj: IDictionary<any, string>

`Optional` removeSelectionMarkers: boolean

`Optional` consumer: string