Plugin

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

Type parameters

Name	Type
`T`	extends `IViewBased` = `IJodit`

Hierarchy

ViewComponent<T>

↳ Plugin

↳↳ addNewLine

↳↳ aiAssistant

↳↳ backspace

↳↳ classSpan

↳↳ cleanHtml

↳↳ deleteCommand

↳↳ dragAndDrop

↳↳ dragAndDropElement

↳↳ enter

↳↳ hotkeys

↳↳ imageProcessor

↳↳ imageProperties

↳↳ inlinePopup

↳↳ keyArrowOutside

↳↳ limit

↳↳ lineHeight

↳↳ link

↳↳ orderedList

↳↳ paste

↳↳ pasteFromWord

↳↳ pasteStorage

↳↳ placeholder

↳↳ redoUndo

↳↳ resizeCells

↳↳ resizeHandler

↳↳ resizer

↳↳ search

↳↳ select

↳↳ selectCells

↳↳ size

↳↳ source

↳↳ SpeechRecognizeNative

↳↳ spellcheck

↳↳ stat

↳↳ sticky

↳↳ symbols

Implements

IPlugin<T>

constructor

new Plugin<T>(jodit): Plugin<T>

Type parameters

Name	Type
`T`	extends `IViewBased`<`IViewOptions`> = `IJodit`

Parameters

Name	Type
`jodit`	`T`

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

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

Inherited from

ViewComponent.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Inherited from

ViewComponent.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Inherited from

ViewComponent.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Inherited from

ViewComponent.ownerWindow

Defined in

src/core/component/component.ts#109

jodit

jodit: T

Parent View element

Inherited from

ViewComponent.jodit

Defined in

src/core/component/view-component.ts#22

requires

Static requires: string[] = []

Implementation of

IPlugin.requires

Defined in

src/core/plugin/plugin.ts#22

buttons

buttons: undefined | IPluginButton[] = []

Implementation of

IPlugin.buttons

Defined in

src/core/plugin/plugin.ts#25

hasStyle

hasStyle: boolean = false

Plugin have CSS style and it should be loaded

Implementation of

IPlugin.hasStyle

Defined in

src/core/plugin/plugin.ts#30

styles

styles: CanUndef<string>

Additional plugin styles can be written simply as inline styles

class A extends Jodit.modules.Plugin {
  styles = 'h1{color: red}';
}

Will only be applied if the plugin is activated

Implementation of

IPlugin.styles

Defined in

src/core/plugin/plugin.ts#41

componentName

get componentName(): string

Returns

string

Inherited from

ViewComponent.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Inherited from

ViewComponent.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Inherited from

ViewComponent.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Inherited from

ViewComponent.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Inherited from

ViewComponent.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Inherited from

ViewComponent.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

Inherited from

ViewComponent.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Inherited from

ViewComponent.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

Inherited from

ViewComponent.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Inherited from

ViewComponent.j

Defined in

src/core/component/view-component.ts#27

defaultTimeout

get defaultTimeout(): number

Returns

number

Inherited from

ViewComponent.defaultTimeout

Defined in

src/core/component/view-component.ts#31

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name	Type	Description
`elementName`	`string`	element name in the bem classification

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name	Type
`elementName`	`string`
`mod`	`string`

Returns

string

Inherited from

ViewComponent.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

Inherited from

ViewComponent.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

Inherited from

ViewComponent.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

Inherited from

ViewComponent.bindDestruct

Defined in

src/core/component/component.ts#170

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name	Type	Description
`componentStatus`	`ComponentStatus`	component status

Returns

void

See

ComponentStatus

Inherited from

ViewComponent.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`