ToolbarEditorCollection

modules/toolbar/collection.ToolbarEditorCollection

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

Hierarchy

constructor

new ToolbarEditorCollection(jodit): ToolbarEditorCollection

Parameters

Name Type
jodit IJodit

Returns

ToolbarEditorCollection

Overrides

ToolbarCollection.constructor

Defined in

src/modules/toolbar/collection/editor-collection.ts#149

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

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

Inherited from

ToolbarCollection.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Inherited from

ToolbarCollection.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Inherited from

ToolbarCollection.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Inherited from

ToolbarCollection.ownerWindow

Defined in

src/core/component/component.ts#109

container

container: HTMLElement

Inherited from

ToolbarCollection.container

Defined in

src/core/ui/element.ts#32

name

name: string = ''

Inherited from

ToolbarCollection.name

Defined in

src/core/ui/element.ts#33

mods

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

Inherited from

ToolbarCollection.mods

Defined in

src/core/ui/element.ts#119

syncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited from

ToolbarCollection.syncMod

Defined in

src/core/ui/group/group.ts#42

elements

elements: IUIElement[] = []

Inherited from

ToolbarCollection.elements

Defined in

src/core/ui/group/group.ts#44

buttonSize

buttonSize: "small" | "tiny" | "xsmall" | "middle" | "large" = 'middle'

Inherited from

ToolbarCollection.buttonSize

Defined in

src/core/ui/group/group.ts#71

options

Optional Readonly options: IDictionary

Inherited from

ToolbarCollection.options

Defined in

src/core/ui/group/group.ts#155

jodit

jodit: IJodit

Parent View element

Inherited from

ToolbarCollection.jodit

Defined in

src/core/ui/group/list.ts#44

mode

mode: "vertical" | "horizontal" = 'horizontal'

Inherited from

ToolbarCollection.mode

Defined in

src/core/ui/group/list.ts#46

componentName

get componentName(): string

Returns

string

Inherited from

ToolbarCollection.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Inherited from

ToolbarCollection.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Inherited from

ToolbarCollection.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Inherited from

ToolbarCollection.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Inherited from

ToolbarCollection.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Inherited from

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

ToolbarCollection.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Inherited from

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

ToolbarCollection.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Inherited from

ToolbarCollection.j

Defined in

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

defaultTimeout

get defaultTimeout(): number

Returns

number

Inherited from

ToolbarCollection.defaultTimeout

Defined in

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

parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Inherited from

ToolbarCollection.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name Type
parentElement Nullable<IUIElement>

Returns

void

Inherited from

ToolbarCollection.parentElement

Defined in

src/core/ui/element.ts#41

allChildren

get allChildren(): IUIElement[]

All group children

Returns

IUIElement[]

Inherited from

ToolbarCollection.allChildren

Defined in

src/core/ui/group/group.ts#49

buttons

get buttons(): IUIButton[]

All buttons from list

Returns

IUIButton[]

Inherited from

ToolbarCollection.buttons

Defined in

src/core/ui/group/list.ts#68

firstButton

get firstButton(): Nullable<IToolbarButton>

First button in a list

Returns

Nullable<IToolbarButton>

Inherited from

ToolbarCollection.firstButton

Defined in

src/modules/toolbar/collection/collection.ts#49

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

ToolbarCollection.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Inherited from

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

ToolbarCollection.getFullElName

Defined in

src/core/component/component.ts#67

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Inherited from

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

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

Inherited from

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

ToolbarCollection.isInstanceOf

Defined in

src/core/component/component.ts#283

i18n

i18n(text, ...params): string

Parameters

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

Returns

string

Inherited from

ToolbarCollection.i18n

Defined in

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

setParentView

setParentView(jodit): this

Attach component to View

Parameters

Name Type
jodit IJodit

Returns

this

Inherited from

ToolbarCollection.setParentView

Defined in

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

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>

Inherited from

ToolbarCollection.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[]

Inherited from

ToolbarCollection.getElms

Defined in

src/core/traits/elms.ts#30

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

Inherited from

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

Inherited from

ToolbarCollection.getMod

Defined in

src/core/traits/mods.ts#64

bubble

bubble(callback): this

Apply callback for all parents

Parameters

Name Type
callback (parent: IUIElement) => void

Returns

this

Inherited from

ToolbarCollection.bubble

Defined in

src/core/ui/element.ts#51

updateParentElement

updateParentElement(target): this

Parameters

Name Type
target IUIElement

Returns

this

Inherited from

ToolbarCollection.updateParentElement

Defined in

src/core/ui/element.ts#62

get

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

Type parameters

Name
T

Parameters

Name Type
chain string
obj? IDictionary

Returns

Nullable<T>

Inherited from

ToolbarCollection.get

Defined in

src/core/ui/element.ts#68

closest

closest<T>(type): Nullable<T extends typeof UIElement ? InstanceType<T<T>> : T>

Find match parent

Type parameters

Name Type
T extends typeof UIElement | UIElement<IViewBased<IViewOptions>>

Parameters

Name Type
type Function | UIElement<IViewBased<IViewOptions>>

Returns

Nullable<T extends typeof UIElement ? InstanceType<T<T>> : T>

Inherited from

ToolbarCollection.closest

Defined in

src/core/ui/element.ts#75

closestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

Parameters

Name Type
node Node
type Function

Returns

Nullable<IUIElement>

Inherited from

ToolbarCollection.closestElement

Defined in

src/core/ui/element.ts#106

appendTo

appendTo(element): this

Append container to element

Parameters

Name Type
element HTMLElement

Returns

this

Inherited from

ToolbarCollection.appendTo

Defined in

src/core/ui/element.ts#131

append

append(elm, distElement?): this

Append new element into group

Parameters

Name Type
elm IUIElement | IUIElement[]
distElement? string

Returns

this

Inherited from

ToolbarCollection.append

Defined in

src/core/ui/group/group.ts#85

afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Inherited from

ToolbarCollection.afterSetMod

Defined in

src/core/ui/group/group.ts#111

remove

remove(elm): this

Remove element from group

Parameters

Name Type
elm IUIElement

Returns

this

Inherited from

ToolbarCollection.remove

Defined in

src/core/ui/group/group.ts#127

clear

clear(): this

Clear group

Returns

this

Inherited from

ToolbarCollection.clear

Defined in

src/core/ui/group/group.ts#142

getButtonsNames

getButtonsNames(): string[]

Helper for getting full plain button list

Returns

string[]

Inherited from

ToolbarCollection.getButtonsNames

Defined in

src/core/ui/group/list.ts#77

setRemoveButtons

setRemoveButtons(removeButtons?): this

Parameters

Name Type
removeButtons? string[]

Returns

this

Inherited from

ToolbarCollection.setRemoveButtons

Defined in

src/core/ui/group/list.ts#85

update

update(): void

Update all children

Returns

void

Inherited from

ToolbarCollection.update

Defined in

src/modules/toolbar/collection/collection.ts#101

setDirection

setDirection(direction): void

Set direction

Parameters

Name Type
direction "rtl" | "ltr"

Returns

void

Inherited from

ToolbarCollection.setDirection

Defined in

src/modules/toolbar/collection/collection.ts#108

build

build(items, target?): this

Parameters

Name Type Default value
items ButtonsGroups undefined
target Nullable<HTMLElement> null

Returns

this

Inherited from

ToolbarCollection.build

Defined in

src/modules/toolbar/collection/collection.ts#137

destruct

destruct(): void

Returns

void

Inherited from

ToolbarCollection.destruct

Defined in

src/modules/toolbar/collection/collection.ts#155

className

className(): string

Returns

string

Overrides

ToolbarCollection.className

Defined in

src/modules/toolbar/collection/editor-collection.ts#28

shouldBeDisabled

shouldBeDisabled(button): boolean

Parameters

Name Type
button IToolbarButton

Returns

boolean

Overrides

ToolbarCollection.shouldBeDisabled

Defined in

src/modules/toolbar/collection/editor-collection.ts#33

shouldBeActive

shouldBeActive(button): boolean

Parameters

Name Type
button IToolbarButton

Returns

boolean

Overrides

ToolbarCollection.shouldBeActive

Defined in

src/modules/toolbar/collection/editor-collection.ts#49

getTarget

getTarget(button): null | Node

Parameters

Name Type
button IToolbarButton

Returns

null | Node

Overrides

ToolbarCollection.getTarget

Defined in

src/modules/toolbar/collection/editor-collection.ts#144

showInline

showInline(bound?): void

Show the inline toolbar inside WYSIWYG editor.

Parameters

Name Type Description
bound? IBound you can set the place for displaying the toolbar, or the place will be in the place of the cursor

Returns

void

Overrides

ToolbarCollection.showInline

Defined in

src/modules/toolbar/collection/editor-collection.ts#175

hide

hide(): void

Returns

void

Overrides

ToolbarCollection.hide

Defined in

src/modules/toolbar/collection/editor-collection.ts#179

show

show(): void

Returns

void

Overrides

ToolbarCollection.show

Defined in

jodit/src/modules/toolbar/collection/editor-collection.ts:185