Hierarchy

Implemented by

Properties

OPTIONS async basePath buffer c componentName componentStatus components container create createInside currentPlace defaultTimeout e ed editor editorDocument editorIsActive editorWindow element events ew filebrowser history id iframe? isDestructed isFocused isFullSize isInDestruct isJodit isLocked isReady isView message mode mods o od options ow ownerDocument ownerWindow parent places progressbar registeredButtons s selection statusbar storage text toolbar toolbarContainer uid uploader value workplace

Methods

addPlace afterSetMod alert bindDestruct className confirm destruct dlg execCommand fetch focus get getEditorValue getElementValue getElm getElms getFullElName getInstance getMod getMode getNativeEditorValue getReadOnly getRealMode getRegisteredButtonGroups getVersion hookStatus i18n isEditorMode isLockedNotBy lock nativeExecCommand prompt registerButton registerCommand registerHotkeyToCommand setCurrentPlace setEditorValue setMod setPanel setReadOnly setStatus toggleFullSize toggleMode unlock unregisterButton waitForReady

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

Readonly createInside

createInside: ICreate

Readonly currentPlace

currentPlace: IWorkPlace

Readonly defaultTimeout

defaultTimeout: number

Readonly e

e: IEventEmitter

Readonly ed

ed: HTMLDocument

Alias for this.ed

editor

editor: HTMLElement

Readonly editorDocument

editorDocument: HTMLDocument

Readonly editorIsActive

editorIsActive: boolean

editorWindow

editorWindow: Window

Readonly element

element: HTMLElement

Readonly events

events: IEventEmitter

Readonly ew

ew: Window

Alias for this.ed

Readonly filebrowser

filebrowser: IFileBrowser<IFileBrowserOptions>

Readonly 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

Readonly isJodit

isJodit: true

Readonly isLocked

isLocked: boolean

Readonly isReady

isReady: boolean

Readonly isView

isView: true

Readonly message

message: IMessages

Readonly mode

mode: Modes

mods

mods: IDictionary<ModType>

Readonly o

o: Config

Readonly od

od: Document

Readonly options

options: Config

Readonly ow

ow: Window

Readonly ownerDocument

ownerDocument: Document

Readonly ownerWindow

ownerWindow: Window

Readonly parent

parent: Nullable<IViewBased<IViewOptions>>

Readonly places

places: IWorkPlace[]

Readonly progressbar

progressbar: IProgressBar

registeredButtons

registeredButtons: Set<IPluginButton>

Readonly s

s: ISelect

Alias for this.selection

Readonly selection

selection: ISelect

Readonly statusbar

statusbar: IStatusBar

Readonly storage

storage: IStorage<StorageValueType>

Readonly text

text: string

toolbar

toolbar: IToolbarCollection

toolbarContainer

toolbarContainer: HTMLElement

Readonly uid

uid: string

Readonly uploader

uploader: IUploader

value

value: string

Readonly workplace

workplace: HTMLDivElement

workplace It contains source and wysiwyg editors

Methods

addPlace

  • Parameters

    Returns void

afterSetMod

  • Parameters

    Returns void

alert

  • Parameters

    • msg: string | HTMLElement
    • Optional title: string | (() => false | void)
    • Optional callback: string | ((dialog) => false | void)
    • Optional className: string

    Returns IDialog

bindDestruct

className

  • Returns string

confirm

  • Parameters

    • msg: string
    • title: undefined | string | ((yes) => void)
    • Optional callback: ((yes) => false | void)
        • (yes): false | void

        • Parameters

          • yes: boolean

          Returns false | void

    Returns IDialog

destruct

dlg

execCommand

  • Parameters

    • command: string
    • Optional showUI: any
    • Optional value: any
    • Rest ...args: unknown[]

    Returns any

fetch

focus

  • Returns void

get

  • Type Parameters

    • T

    Parameters

    Returns Nullable<T>

getEditorValue

  • Parameters

    • Optional removeSelectionMarkers: boolean
    • Optional consumer: string

    Returns string

getElementValue

  • Only getter

    Returns string

getElm

getElms

getFullElName

  • Parameters

    • elementName: string

    Returns string

  • Parameters

    • elementName: string
    • mod: string

    Returns string

  • Parameters

    • elementName: string
    • Optional mod: string
    • Optional modValue: string | boolean

    Returns string

getInstance

  • Type Parameters

    Parameters

    • moduleName: string
    • Optional options: object

    Returns T

getMod

getMode

getNativeEditorValue

  • Returns string

getReadOnly

  • Returns boolean

getRealMode

  • 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());

getRegisteredButtonGroups

getVersion

  • Returns string

hookStatus

  • Parameters

    • status: ComponentStatus
    • callback: ((component) => void)
        • (component): void

        • Parameters

          Returns void

    Returns void

i18n

  • Parameters

    • text: string
    • Rest ...params: (string | number)[]

    Returns string

isEditorMode

  • Returns boolean

isLockedNotBy

  • Parameters

    • name: string

    Returns boolean

lock

  • Parameters

    • Optional name: string

    Returns boolean

nativeExecCommand

  • Parameters

    • command: string
    • Optional showUI: any
    • Optional value: any

    Returns boolean

prompt

  • Parameters

    • msg: string
    • title: undefined | string | (() => false | void)
    • callback: ((value) => false | void)
        • (value): false | void

        • Parameters

          • value: string

          Returns false | void

    • Optional placeholder: string
    • Optional defaultValue: string

    Returns IDialog

registerButton

registerCommand

  • Type Parameters

    • C extends string

    Parameters

    • commandNameOriginal: C
    • command: CustomCommand<IJodit, C>
    • Optional options: {
          stopPropagation: boolean;
      }
      • stopPropagation: boolean

    Returns IJodit

registerHotkeyToCommand

  • Parameters

    • hotkeys: string | string[]
    • commandName: string
    • Optional shouldStop: boolean

    Returns void

setCurrentPlace

  • Parameters

    Returns void

setEditorValue

  • Parameters

    • Optional value: string

    Returns void

setMod

setPanel

  • Parameters

    Returns void

setReadOnly

  • Parameters

    • enable: boolean

    Returns void

setStatus

  • Parameters

    Returns void

toggleFullSize

  • Parameters

    • Optional isFullSize: boolean

    Returns void

toggleMode

  • Returns void

unlock

  • Returns boolean

unregisterButton

waitForReady

Jodit PRO

If you like Jodit - try Jodit PRO