Jodit Editor

ViewWithToolbar

view.ViewWithToolbar

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

Hierarchy

Implements

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

Name Type
beforeInit "beforeInit"
ready "ready"
beforeDestruct "beforeDestruct"
destructed "destructed"

Inherited from

View.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Implementation of

IViewWithToolbar.async

Inherited from

View.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Implementation of

IViewWithToolbar.uid

Inherited from

View.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation of

IViewWithToolbar.ownerWindow

Inherited from

View.ownerWindow

Defined in

src/core/component/component.ts#109

TOOLBAR

TOOLBAR: IToolbarCollection

Defined in

src/core/view/view-with-toolbar.ts#34

toolbar

toolbar: IToolbarCollection

Implementation of

IViewWithToolbar.toolbar

Defined in

src/core/view/view-with-toolbar.ts#35

registeredButtons

registeredButtons: Set<IPluginButton>

Implementation of

IViewWithToolbar.registeredButtons

Defined in

src/core/view/view-with-toolbar.ts#87

isJodit

Readonly isJodit: boolean = false

Overrides

View.isJodit

Defined in

src/core/view/view-with-toolbar.ts#164

isView

Readonly isView: true

Implementation of

IViewWithToolbar.isView

Inherited from

View.isView

Defined in

src/core/view/view.ts#61

parent

parent: Nullable<IViewBased<IViewOptions>> = null

Implementation of

IViewWithToolbar.parent

Inherited from

View.parent

Defined in

src/core/view/view.ts#62

mods

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

Implementation of

IViewWithToolbar.mods

Inherited from

View.mods

Defined in

src/core/view/view.ts#64

id

id: string

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

Implementation of

IViewWithToolbar.id

Inherited from

View.id

Defined in

src/core/view/view.ts#69

components

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

All created ViewComponent inside this view

Implementation of

IViewWithToolbar.components

Inherited from

View.components

Defined in

src/core/view/view.ts#74

ES

Static Readonly ES: "es5" | "es2015" | "es2018" | "es2021" = ES

Inherited from

View.ES

Defined in

src/core/view/view.ts#88

version

Static Readonly version: string = APP_VERSION

Inherited from

View.version

Defined in

src/core/view/view.ts#89

esNext

Static Readonly esNext: boolean = IS_ES_NEXT

Inherited from

View.esNext

Defined in

src/core/view/view.ts#90

esModern

Static Readonly esModern: boolean = IS_ES_MODERN

Inherited from

View.esModern

Defined in

src/core/view/view.ts#91

create

Readonly create: ICreate

Implementation of

IViewWithToolbar.create

Inherited from

View.create

Defined in

src/core/view/view.ts#127

events

events: IEventEmitter

Implementation of

IViewWithToolbar.events

Inherited from

View.events

Defined in

src/core/view/view.ts#146

OPTIONS

OPTIONS: IViewOptions = View.defaultOptions

Implementation of

IViewWithToolbar.OPTIONS

Inherited from

View.OPTIONS

Defined in

src/core/view/view.ts#164

defaultOptions

Static defaultOptions: IViewOptions

Inherited from

View.defaultOptions

Defined in

src/core/view/view.ts#393

componentName

get componentName(): string

Returns

string

Implementation of

IViewWithToolbar.componentName

Inherited from

View.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Implementation of

IViewWithToolbar.ownerDocument

Inherited from

View.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Implementation of

IViewWithToolbar.od

Inherited from

View.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Implementation of

IViewWithToolbar.ow

Inherited from

View.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Implementation of

IViewWithToolbar.isReady

Inherited from

View.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Implementation of

IViewWithToolbar.isDestructed

Inherited from

View.isDestructed

Defined in

src/core/component/component.ts#152

isInDestruct

get isInDestruct(): boolean

The component is currently undergoing destructuring or has already been destroyed.
Those. you should not the app froze new events on him now or do anything else with him.

Returns

boolean

Implementation of

IViewWithToolbar.isInDestruct

Inherited from

View.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Implementation of

IViewWithToolbar.componentStatus

Inherited from

View.componentStatus

Defined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Implementation of

IViewWithToolbar.componentStatus

Inherited from

View.componentStatus

Defined in

src/core/component/component.ts#217

toolbarContainer

get toolbarContainer(): HTMLElement

Container for toolbar

Returns

HTMLElement

Implementation of

IViewWithToolbar.toolbarContainer

Defined in

src/core/view/view-with-toolbar.ts#43

basePath

get basePath(): string

Get a path for loading extra staff

Returns

string

Implementation of

IViewWithToolbar.basePath

Inherited from

View.basePath

Defined in

src/core/view/view.ts#79

defaultTimeout

get defaultTimeout(): number

Return a default timeout period in milliseconds for some debounce or throttle functions.
By default, {history.timeout} options

Returns

number

Implementation of

IViewWithToolbar.defaultTimeout

Inherited from

View.defaultTimeout

Defined in

src/core/view/view.ts#97

buffer

get buffer(): IStorage<StorageValueType>

Some extra data inside editor

Returns

IStorage<StorageValueType>

See

copyformat plugin

Implementation of

IViewWithToolbar.buffer

Inherited from

View.buffer

Defined in

src/core/view/view.ts#106

message

get message(): IMessages

Returns

IMessages

Implementation of

IViewWithToolbar.message

Inherited from

View.message

Defined in

src/core/view/view.ts#111

storage

get storage(): IStorage<StorageValueType>

Container for persistent set/get value

Returns

IStorage<StorageValueType>

Implementation of

IViewWithToolbar.storage

Inherited from

View.storage

Defined in

src/core/view/view.ts#123

c

get c(): this["create"]

Short alias for create

Returns

this["create"]

Implementation of

IViewWithToolbar.c

Inherited from

View.c

Defined in

src/core/view/view.ts#133

container

get container(): HTMLDivElement

Returns

HTMLDivElement

Implementation of

IViewWithToolbar.container

Inherited from

View.container

Defined in

src/core/view/view.ts#138

set container(container): void

Parameters

Name Type
container HTMLDivElement

Returns

void

Implementation of

IViewWithToolbar.container

Inherited from

View.container

Defined in

src/core/view/view.ts#142

e

get e(): this["events"]

Short alias for events

Returns

this["events"]

Implementation of

IViewWithToolbar.e

Inherited from

View.e

Defined in

src/core/view/view.ts#152

progressbar

get progressbar(): IProgressBar

progress_bar Progress bar

Returns

IProgressBar

Implementation of

IViewWithToolbar.progressbar

Inherited from

View.progressbar

Defined in

src/core/view/view.ts#160

options

get options(): this["OPTIONS"]

Returns

this["OPTIONS"]

Implementation of

IViewWithToolbar.options

Inherited from

View.options

Defined in

src/core/view/view.ts#166

set options(options): void

Parameters

Name Type
options this["OPTIONS"]

Returns

void

Implementation of

IViewWithToolbar.options

Inherited from

View.options

Defined in

src/core/view/view.ts#170

o

get o(): this["options"]

Short alias for options

Returns

this["options"]

Implementation of

IViewWithToolbar.o

Inherited from

View.o

Defined in

src/core/view/view.ts#177

isLocked

get isLocked(): boolean

View is locked

Returns

boolean

Implementation of

IViewWithToolbar.isLocked

Inherited from

View.isLocked

Defined in

src/core/view/view.ts#208

isFullSize

get isFullSize(): boolean

View is in fullSize

Returns

boolean

Implementation of

IViewWithToolbar.isFullSize

Inherited from

View.isFullSize

Defined in

src/core/view/view.ts#242

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name Type Description
elementName string element name in the bem classification

Returns

string

Implementation of

IViewWithToolbar.getFullElName

Inherited from

View.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Implementation of

IViewWithToolbar.getFullElName

Inherited from

View.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

Parameters

Name Type
elementName string
mod string
modValue string | boolean

Returns

string

Implementation of

IViewWithToolbar.getFullElName

Inherited from

View.getFullElName

Defined in

src/core/component/component.ts#67

get

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

Safe get any field

Type parameters

Name
T

Parameters

Name Type Description
chain string the path to be traversed in the obj object
obj? IDictionary the object in which the value is searched

Returns

Nullable<T>

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

Implementation of

IViewWithToolbar.get

Inherited from

View.get

Defined in

src/core/component/component.ts#138

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Implementation of

IViewWithToolbar.bindDestruct

Inherited from

View.bindDestruct

Defined in

src/core/component/component.ts#170

className

className(): string

Returns

string

Implementation of

IViewWithToolbar.className

Inherited from

View.className

Defined in

src/core/component/component.ts#179

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name Type Description
componentStatus ComponentStatus component status

Returns

void

See

ComponentStatus

Implementation of

IViewWithToolbar.setStatus

Inherited from

View.setStatus

Defined in

src/core/component/component.ts#226

hookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

Parameters

Name Type Description
status ComponentStatus the status at which the callback is triggered
callback (component: this) => void a function that will be called when the status is status

Returns

void

Implementation of

IViewWithToolbar.hookStatus

Inherited from

View.hookStatus

Defined in

src/core/component/component.ts#265

isInstanceOf

isInstanceOf<T>(c, constructorFunc): c is T

Type parameters

Name Type
T extends Component

Parameters

Name Type
c unknown
constructorFunc Function

Returns

c is T

Inherited from

View.isInstanceOf

Defined in

src/core/component/component.ts#283

getElm

getElm<T>(this, elementName): Nullable<HTMLElement>

Return element with BEM class name

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms

Parameters

Name Type
this T
elementName string

Returns

Nullable<HTMLElement>

Implementation of

IViewWithToolbar.getElm

Inherited from

View.getElm

Defined in

src/core/traits/elms.ts#18

getElms

getElms<T>(this, elementName): HTMLElement[]

Return elements with BEM class name

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms

Parameters

Name Type
this T
elementName string

Returns

HTMLElement[]

Implementation of

IViewWithToolbar.getElms

Inherited from

View.getElms

Defined in

src/core/traits/elms.ts#30

afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Implementation of

IViewWithToolbar.afterSetMod

Inherited from

View.afterSetMod

Defined in

src/core/traits/mods.ts#23

setMod

setMod<T>(this, name, value, container?): T

Set/remove BEM class modification

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IMods

Parameters

Name Type Description
this T -
name string -
value ModType if null, mod will be removed
container? HTMLElement -

Returns

T

Implementation of

IViewWithToolbar.setMod

Inherited from

View.setMod

Defined in

src/core/traits/mods.ts#30

getMod

getMod(this, name): ModType

Get BEM class modification value

Parameters

Name Type
this IMods
name string

Returns

ModType

Implementation of

IViewWithToolbar.getMod

Inherited from

View.getMod

Defined in

src/core/traits/mods.ts#64

setPanel

setPanel(element): void

Change panel container

Parameters

Name Type
element string | HTMLElement

Returns

void

Implementation of

IViewWithToolbar.setPanel

Defined in

src/core/view/view-with-toolbar.ts#63

getRegisteredButtonGroups

getRegisteredButtonGroups(): IDictionary<string[]>

Returns

IDictionary<string[]>

Implementation of

IViewWithToolbar.getRegisteredButtonGroups

Defined in

src/core/view/view-with-toolbar.ts#90

registerButton

registerButton(btn): this

Register button for a group

Parameters

Name Type
btn IPluginButton

Returns

this

Implementation of

IViewWithToolbar.registerButton

Defined in

src/core/view/view-with-toolbar.ts#97

unregisterButton

unregisterButton(btn): this

Remove button from a group

Parameters

Name Type
btn IPluginButton

Returns

this

Implementation of

IViewWithToolbar.unregisterButton

Defined in

src/core/view/view-with-toolbar.ts#117

destruct

destruct(): void

Returns

void

Implementation of

IViewWithToolbar.destruct

Overrides

View.destruct

Defined in

src/core/view/view-with-toolbar.ts#177

i18n

i18n(text, ...params): string

Internationalization method. Uses Jodit.lang object

Parameters

Name Type
text string
...params (string | number)[]

Returns

string

Implementation of

IViewWithToolbar.i18n

Inherited from

View.i18n

Defined in

src/core/view/view.ts#184

toggleFullSize

toggleFullSize(isFullSize?): void

Parameters

Name Type
isFullSize? boolean

Returns

void

Implementation of

IViewWithToolbar.toggleFullSize

Inherited from

View.toggleFullSize

Defined in

src/core/view/view.ts#190

isLockedNotBy

isLockedNotBy(name): boolean

Parameters

Name Type
name string

Returns

boolean

Implementation of

IViewWithToolbar.isLockedNotBy

Inherited from

View.isLockedNotBy

Defined in

src/core/view/view.ts#212

lock

lock(name?): boolean

Disable selecting

Parameters

Name Type Default value
name string 'any'

Returns

boolean

Implementation of

IViewWithToolbar.lock

Inherited from

View.lock

Defined in

src/core/view/view.ts#218

unlock

unlock(): boolean

Enable selecting

Returns

boolean

Implementation of

IViewWithToolbar.unlock

Inherited from

View.unlock

Defined in

src/core/view/view.ts#230

getVersion

getVersion(): string

Return current version

Returns

string

Implementation of

IViewWithToolbar.getVersion

Inherited from

View.getVersion

Defined in

src/core/view/view.ts#249

getVersion

getVersion(): string

Returns

string

Inherited from

View.getVersion

Defined in

src/core/view/view.ts#253

getInstance

getInstance<T>(module, options?): T

Make one instance of one module

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>>

Parameters

Name Type
module Function
options? object

Returns

T

Implementation of

IViewWithToolbar.getInstance

Inherited from

View.getInstance

Defined in

jodit/src/core/view/view.ts:306

getInstance<T>(moduleName, options?): T

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>>

Parameters

Name Type
moduleName string
options? object

Returns

T

Implementation of

IViewWithToolbar.getInstance

Inherited from

View.getInstance

Defined in

jodit/src/core/view/view.ts:307

In this article: