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
Readonly
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 Jodit
is Jodit : true
Readonly
is Locked
is Locked : boolean
Readonly
is Ready
is Ready : boolean
Readonly
is View
is View : true
Readonly
text
text : string
Methods
add Place
add Place ( source , options ? ) : void
Returns void
after Set Mod
after Set Mod ( name , value ) : void
Returns void
alert
alert ( msg , title ? , callback ? , className ? ) : IDialog
Parameters
Optional
title : string | ( ( ) => false | void )
Optional
callback : string | ( ( dialog ) => false | void )
Optional
className : string
bind Destruct
bind Destruct ( component ) : IJodit
class Name
class Name ( ) : string
Returns string
confirm
confirm ( msg , title , callback ? ) : IDialog
Parameters
msg : string
title : undefined | string | ( ( yes ) => void )
Optional
callback : ( ( yes ) => false | void )
( yes ) : false | void
Returns false | void
destruct
destruct ( jodit ? ) : any
Returns any
exec Command
exec Command ( command , showUI ? , value ? , ... args ) : any
Parameters
command : string
Optional
showUI : any
Optional
value : any
Rest
... args : unknown []
Returns any
focus
focus ( ) : void
Returns void
get Editor Value
get Editor Value ( removeSelectionMarkers ? , consumer ? ) : 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
Returns string
get Full El Name ( elementName , mod ) : string
Parameters
elementName : string
mod : string
Returns string
get Full El Name ( elementName , mod ? , modValue ? ) : string
Parameters
elementName : string
Optional
mod : string
Optional
modValue : string | boolean
Returns string
get Instance
get Instance < T > ( moduleName , options ? ) : 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 , callback ) : void
Parameters
callback : ( ( component ) => void )
( component ) : void
Returns void
Returns void
i18n
i18n ( text , ... params ) : 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 ) : boolean
Returns boolean
lock
lock ( name ? ) : boolean
Returns boolean
native Exec Command
native Exec Command ( command , showUI ? , value ? ) : boolean
Parameters
command : string
Optional
showUI : any
Optional
value : any
Returns boolean
prompt
prompt ( msg , title , callback , placeholder ? , defaultValue ? ) : IDialog
Parameters
msg : string
title : undefined | string | ( ( ) => false | void )
callback : ( ( value ) => false | void )
( value ) : false | void
Returns false | void
Optional
placeholder : string
Optional
defaultValue : string
register Command
register Command < C > ( commandNameOriginal , command , options ? ) : IJodit
Parameters
commandNameOriginal : C
Optional
options : { Â Â Â Â stopPropagation : boolean ; }
register Hotkey To Command
register Hotkey To Command ( hotkeys , commandName , shouldStop ? ) : void
Parameters
hotkeys : string | string []
commandName : string
Optional
shouldStop : boolean
Returns void
set Current Place
set Current Place ( place ) : void
Returns void
set Editor Value
set Editor Value ( value ? ) : void
Returns void
set Mod
set Mod < T > ( this , name , value ) : T
Returns T
set Panel
set Panel ( element ) : void
Returns void
set Read Only
set Read Only ( enable ) : void
Returns void
set Status
set Status ( componentStatus ) : void
Returns void
toggle Full Size
toggle Full Size ( isFullSize ? ) : void
Parameters
Optional
isFullSize : boolean
Returns void
toggle Mode
toggle Mode ( ) : void
Returns void
unlock
unlock ( ) : boolean
Returns boolean
Alias for this.ed