View | Jodit Editor

The base class of all Jodit UI components. Provides work with a life cycle.

Hierarchy

Implements

Properties

OPTIONS

OPTIONS: IViewOptions = View.defaultOptions

`Static` STATUSES

STATUSES: {
    beforeDestruct: "beforeDestruct";
    beforeInit: "beforeInit";
    destructed: "destructed";
    ready: "ready";
} = STATUSES

Type declaration

beforeDestruct: "beforeDestruct"
beforeInit: "beforeInit"
destructed: "destructed"
ready: "ready"

`Readonly` async

async: IAsync = ...

`Readonly` buffer

buffer: IStorage<StorageValueType> = ...

Some extra data inside editor

See

copyformat plugin

`Readonly` components

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

All created ViewComponent inside this view

`Readonly` create

create: ICreate

`Static` defaultOptions

defaultOptions: IViewOptions

`Static` `Readonly` esNext

esNext: boolean = isESNext

`Readonly` events

events: IEventEmitter

id

id: string

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

`Readonly` isJodit

isJodit: boolean = false

`Readonly` isView

isView: true = ...

message

message: IMessages

`Readonly` mods

mods: IDictionary<null | string | boolean, string> = {}

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

parent

parent: Nullable<IViewBased<IViewOptions>> = null

progressbar

progressbar: IProgressBar

progress_bar Progress bar

`Readonly` storage

storage: IStorage<StorageValueType> = ...

Container for persistent set/get value

`Readonly` uid

uid: string

`Readonly` version

version: string = appVersion

Methods

afterSetMod

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

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): View
Bind destructor to some View
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns View

`Abstract` className

className(): string
Returns string

destruct

destruct(): void
Returns void

get

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

Safe get any field

Example

private a = {
    b: {
        c: {
            e: {
                g: {
                    color: 'red'
                }
            }
        }
    }
}

this.get('a.b.c.e.g.color'); // Safe access to color
// instead using optionsl chaining
this?.a?.b?.c?.e?.g?.color

Type Parameters

Parameters

chain: string

the path to be traversed in the obj object
Optional obj: IDictionary<any, string>

the object in which the value is searched

Returns Nullable<T>

getElm

getElm<T>(this: T, elementName: string): Nullable<HTMLElement>
Return element with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms<T>(this: T, elementName: string): HTMLElement[]
Return elements with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Calc BEM element class name
Parameters
- elementName: string
  
  element name in the bem classification
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
- mod: string
- modValue: string | boolean
Returns string

getInstance

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

getMod

getMod(this: IMods, name: string): ModType
Get BEM class modification value
Parameters
- this: IMods
- name: string
Returns ModType

`Static` getVersion

getVersion(): string
Returns string

getVersion

getVersion(): string
Return current version

Returns string

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: View) => void)): void
Adds a handler for changing the component's status
Parameters
- status: ComponentStatus
  
  the status at which the callback is triggered
- callback: ((component: View) => void)
  
  a function that will be called when the status is status
  - - (component: View): void
    - Parameters
      
      component: View
      
      Returns void
Returns void

i18n

i18n(text: string, ...params: (string | number)[]): string
Internationalization method. Uses Jodit.lang object
Parameters
- text: string
- Rest ...params: (string | number)[]
Returns string

`Static` isInstanceOf

isInstanceOf<T>(c: unknown, constructorFunc: Function): c is T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T>
Parameters
- c: unknown
- constructorFunc: Function
Returns c is T

isLockedNotBy

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

lock

lock(name?: string): boolean
Disable selecting
Parameters
- name: string = 'any'
Returns boolean

setMod

setMod<T>(this: T, name: string, value: ModType, container?: HTMLElement): T
Set/remove BEM class modification
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
  
  if null, mod will be removed
- Optional container: HTMLElement
Returns T

setStatus

setStatus(componentStatus: ComponentStatus): void
Set component status

See
ComponentStatus
Parameters
- componentStatus: ComponentStatus
  
  component status
Returns void

toggleFullSize

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

unlock

unlock(): boolean
Enable selecting

Returns boolean

Accessors

basePath

get basePath(): string
Get path for loading extra staff

Returns string

c

get c(): this["create"]
Returns this["create"]

componentName

get componentName(): string
Returns string

componentStatus

get componentStatus(): ComponentStatus
Current component status

Returns ComponentStatus
set componentStatus(componentStatus: ComponentStatus): void
Setter for current component status
Parameters
- componentStatus: ComponentStatus
Returns void

container

get container(): HTMLDivElement
Returns HTMLDivElement
set container(container: HTMLDivElement): void
Parameters
- container: HTMLDivElement
Returns void

defaultTimeout

get defaultTimeout(): number
Return default timeout period in milliseconds for some debounce or throttle functions. By default, {history.timeout} options

Returns number

e

get e(): this["events"]
Returns this["events"]

isDestructed

get isDestructed(): boolean
Component was destructed

Returns boolean

isFullSize

get isFullSize(): boolean
View is in fullSize

Returns boolean

isInDestruct

get isInDestruct(): boolean
The component is currently undergoing destructuring or has already been destroyed. Those. you should not hang new events on him now or do anything else with him.

Returns boolean

isLocked

get isLocked(): boolean
View is locked

Returns boolean

isReady

get isReady(): boolean
Component is ready for work

Returns boolean

o

get o(): this["options"]
Short alias for options

Returns this["options"]

od

get od(): Document
Shortcut for this.ownerDocument

Returns Document

options

get options(): this["OPTIONS"]
Returns this["OPTIONS"]
set options(options: this["OPTIONS"]): void
Parameters
- options: this["OPTIONS"]
Returns void

ow

get ow(): Window
Returns Window

ownerDocument

get ownerDocument(): Document
The document in which jodit was created

Returns Document

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implements

Index

Properties

Methods

Accessors

Properties

OPTIONS

Static STATUSES

Type declaration

beforeDestruct: "beforeDestruct"

beforeInit: "beforeInit"

destructed: "destructed"

ready: "ready"

Readonly async

Readonly buffer

See

Readonly components

Readonly create

Static defaultOptions

Static Readonly esNext

Readonly events

id

Readonly isJodit

Readonly isView

message

Readonly mods

ownerWindow

parent

progressbar

Readonly storage

Readonly uid

Readonly version

Methods

afterSetMod

Parameters

name: string

value: ModType

Returns void

bindDestruct

Parameters

component: IComponent<IViewBased<IViewOptions>>

Returns View

Abstract className

Returns string

destruct

Returns void

get

Example

Type Parameters

T

Parameters

chain: string

Optional obj: IDictionary<any, string>

Returns Nullable<T>

getElm

Type Parameters

T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms

Parameters

this: T

elementName: string

Returns Nullable<HTMLElement>

getElms

Type Parameters

T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms

Parameters

this: T

elementName: string

Returns HTMLElement[]

getFullElName

Parameters

elementName: string

Returns string

Parameters

elementName: string

mod: string

Returns string

Parameters

elementName: string

mod: string

`Static` STATUSES

`Readonly` async

`Readonly` buffer

`Readonly` components

`Readonly` create

`Static` defaultOptions

`Static` `Readonly` esNext

`Readonly` events

`Readonly` isJodit

`Readonly` isView

`Readonly` mods

`Readonly` storage

`Readonly` uid

`Readonly` version

`Abstract` className

`Optional` obj: IDictionary<any, string>

`Optional` options: object

`Static` getVersion

`Rest` ...params: (string | number)[]

`Static` isInstanceOf

`Optional` container: HTMLElement

`Optional` isFullSize: boolean