Preparing search index...
The search index is not available
Properties
Readonly
base Path
base Path: string
Readonly
component Name
component Name: string
Readonly
default Timeout
default Timeout: number
editor Is Active
editor Is Active: boolean
Readonly
is Destructed
is Destructed: boolean
Readonly
is Focused
is Focused: boolean
Readonly
is Full Size
is Full Size: boolean
Readonly
is In Destruct
is In Destruct: boolean
Readonly
is Locked
is Locked: boolean
Readonly
is Ready
is Ready: boolean
Readonly
is View
is View: true
Methods
after Set Mod
after Set Mod( name: string , value: ModType ) : void
Returns void
alert
alert( msg: string | HTMLElement , title?: string | ( ( ) => false | void ) , callback?: string | ( ( dialog: IDialog ) => false | void ) , className?: string ) : IDialog
Parameters
Optional
title: string | ( ( ) => false | void )
Optional
callback: string | ( ( dialog: IDialog ) => false | void )
Optional
className: string
class Name
class Name( ) : 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
Returns false | void
exec Command
exec Command( 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
focus
focus( ) : void
Returns void
get Editor Value
get Editor Value( removeSelectionMarkers?: boolean , consumer?: string ) : string
Parameters
Optional
removeSelectionMarkers: boolean
Optional
consumer: string
Returns string
get Element Value
get Element Value( ) : string
Returns string
get Full El Name
get Full El Name( elementName: string ) : string
Returns string
get Full El Name( elementName: string , mod: string ) : string
Parameters
elementName: string
mod: string
Returns string
get Full El Name( elementName: string , mod?: string , modValue?: string | boolean ) : string
Parameters
elementName: string
Optional
mod: string
Optional
modValue: string | boolean
Returns string
get Instance
get Instance< T > ( moduleName: string , options?: object ) : T
Parameters
moduleName: string
Optional
options: object
Returns T
get Native Editor Value
get Native Editor Value( ) : string
Returns string
get Read Only
get Read Only( ) : boolean
Returns boolean
get Registered Button Groups
get Version
get Version( ) : string
Returns string
hook Status
hook Status( status: ComponentStatus , callback: ( ( component: IJodit ) => void ) ) : void
Parameters
callback: ( ( component: IJodit ) => void )
( component: IJodit ) : void
Returns void
Returns void
i18n
i18n( text: string , ... params: ( string | number ) [] ) : string
Parameters
text: string
Rest
... params: ( string | number ) []
Returns string
is Editor Mode
is Editor Mode( ) : boolean
Returns boolean
is Locked Not By
is Locked Not By( name: string ) : boolean
Returns boolean
lock
lock( name?: string ) : boolean
Returns boolean
native Exec Command
native Exec Command( 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
Returns false | void
Optional
placeholder: string
Optional
defaultValue: string
register Command
register Command< C > ( commandNameOriginal: C , command: CustomCommand < IJodit , C > , options?: { stopPropagation: boolean ; } ) : IJodit
Parameters
commandNameOriginal: C
Optional
options: { stopPropagation: boolean ; }
register Hotkey To Command
register Hotkey To Command( hotkeys: string | string [] , commandName: string , shouldStop?: boolean ) : void
Parameters
hotkeys: string | string []
commandName: string
Optional
shouldStop: boolean
Returns void
set Current Place
set Current Place( place: IWorkPlace ) : void
Returns void
set Editor Value
set Editor Value( value?: string ) : void
Returns void
set Mod
set Mod< T > ( this: T , name: string , value: ModType ) : T
Returns T
set Panel
set Panel( element: string | HTMLElement ) : void
Returns void
set Read Only
set Read Only( enable: boolean ) : void
Returns void
toggle Full Size
toggle Full Size( isFullSize?: boolean ) : void
Parameters
Optional
isFullSize: boolean
Returns void
toggle Mode
toggle Mode( ) : void
Returns void
unlock
unlock( ) : boolean
Returns boolean
Alias for this.ed