ToolbarCollection

modules/toolbar/collection.ToolbarCollection

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

Type parametersType parameters

Name	Type
T	extends IViewWithToolbar = IViewWithToolbar

HierarchyHierarchy

• UIList<T>

  ↳ ToolbarCollection

  ↳↳ ToolbarEditorCollection

ImplementsImplements

• IToolbarCollection

constructorconstructor

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

Type parametersType parameters

Name	Type
T	extends IViewWithToolbar<IViewOptions> = IViewWithToolbar<IViewOptions>

ParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturns

ToolbarCollection<T>

OverridesOverrides

UIList.constructor

Defined inDefined in

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

STATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declaration

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

Inherited fromInherited from

UIList.STATUSES

Defined inDefined in

src/core/component/component.ts#40

---

asyncasync

async: IAsync

Implementation ofImplementation of

IToolbarCollection.async

Inherited fromInherited from

UIList.async

Defined inDefined in

src/core/component/component.ts#44

---

uiduid

Readonly uid: string

Implementation ofImplementation of

IToolbarCollection.uid

Inherited fromInherited from

UIList.uid

Defined inDefined in

src/core/component/component.ts#59

---

ownerWindowownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation ofImplementation of

IToolbarCollection.ownerWindow

Inherited fromInherited from

UIList.ownerWindow

Defined inDefined in

src/core/component/component.ts#109

---

containercontainer

container: HTMLElement

Implementation ofImplementation of

IToolbarCollection.container

Inherited fromInherited from

UIList.container

Defined inDefined in

src/core/ui/element.ts#32

---

namename

name: string = ''

Implementation ofImplementation of

IToolbarCollection.name

Inherited fromInherited from

UIList.name

Defined inDefined in

src/core/ui/element.ts#33

---

modsmods

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

Implementation ofImplementation of

IToolbarCollection.mods

Inherited fromInherited from

UIList.mods

Defined inDefined in

src/core/ui/element.ts#119

---

syncModsyncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited fromInherited from

UIList.syncMod

Defined inDefined in

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

---

elementselements

elements: IUIElement[] = []

Implementation ofImplementation of

IToolbarCollection.elements

Inherited fromInherited from

UIList.elements

Defined inDefined in

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

---

buttonSizebuttonSize

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

Implementation ofImplementation of

IToolbarCollection.buttonSize

Inherited fromInherited from

UIList.buttonSize

Defined inDefined in

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

---

optionsoptions

Optional Readonly options: IDictionary

Inherited fromInherited from

UIList.options

Defined inDefined in

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

---

joditjodit

jodit: T

Parent View element

Implementation ofImplementation of

IToolbarCollection.jodit

Inherited fromInherited from

UIList.jodit

Defined inDefined in

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

---

modemode

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

Implementation ofImplementation of

IToolbarCollection.mode

Inherited fromInherited from

UIList.mode

Defined inDefined in

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

componentNamecomponentName

get componentName(): string

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.componentName

Inherited fromInherited from

UIList.componentName

Defined inDefined in

src/core/component/component.ts#46

---

ownerDocumentownerDocument

get ownerDocument(): Document

The document in which jodit was created

ReturnsReturns

Document

Implementation ofImplementation of

IToolbarCollection.ownerDocument

Inherited fromInherited from

UIList.ownerDocument

Defined inDefined in

src/core/component/component.ts#95

---

odod

get od(): Document

Shortcut for this.ownerDocument

ReturnsReturns

Document

Implementation ofImplementation of

IToolbarCollection.od

Inherited fromInherited from

UIList.od

Defined inDefined in

src/core/component/component.ts#102

---

owow

get ow(): Window

ReturnsReturns

Window

Implementation ofImplementation of

IToolbarCollection.ow

Inherited fromInherited from

UIList.ow

Defined inDefined in

src/core/component/component.ts#110

---

isReadyisReady

get isReady(): boolean

Component is ready for work

ReturnsReturns

boolean

Implementation ofImplementation of

IToolbarCollection.isReady

Inherited fromInherited from

UIList.isReady

Defined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturns

boolean

Implementation ofImplementation of

IToolbarCollection.isDestructed

Inherited fromInherited from

UIList.isDestructed

Defined inDefined in

src/core/component/component.ts#152

---

isInDestructisInDestruct

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.

ReturnsReturns

boolean

Implementation ofImplementation of

IToolbarCollection.isInDestruct

Inherited fromInherited from

UIList.isInDestruct

Defined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturns

ComponentStatus

Implementation ofImplementation of

IToolbarCollection.componentStatus

Inherited fromInherited from

UIList.componentStatus

Defined inDefined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

ParametersParameters

Name	Type
componentStatus	ComponentStatus

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.componentStatus

Inherited fromInherited from

UIList.componentStatus

Defined inDefined in

src/core/component/component.ts#217

---

jj

get j(): T

Shortcut for this.jodit

ReturnsReturns

T

Implementation ofImplementation of

IToolbarCollection.j

Inherited fromInherited from

UIList.j

Defined inDefined in

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

---

defaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturns

number

Implementation ofImplementation of

IToolbarCollection.defaultTimeout

Inherited fromInherited from

UIList.defaultTimeout

Defined inDefined in

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

---

parentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation of

IToolbarCollection.parentElement

Inherited fromInherited from

UIList.parentElement

Defined inDefined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

ParametersParameters

Name	Type
parentElement	Nullable<IUIElement>

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.parentElement

Inherited fromInherited from

UIList.parentElement

Defined inDefined in

src/core/ui/element.ts#41

---

allChildrenallChildren

get allChildren(): IUIElement[]

All group children

ReturnsReturns

IUIElement[]

Implementation ofImplementation of

IToolbarCollection.allChildren

Inherited fromInherited from

UIList.allChildren

Defined inDefined in

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

---

buttonsbuttons

get buttons(): IUIButton[]

All buttons from list

ReturnsReturns

IUIButton[]

Implementation ofImplementation of

IToolbarCollection.buttons

Inherited fromInherited from

UIList.buttons

Defined inDefined in

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

---

firstButtonfirstButton

get firstButton(): Nullable<IToolbarButton>

First button in a list

ReturnsReturns

Nullable<IToolbarButton>

Implementation ofImplementation of

IToolbarCollection.firstButton

Defined inDefined in

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

getFullElNamegetFullElName

getFullElName(elementName): string

Calc BEM element class name

ParametersParameters

Name	Type	Description
elementName	string	element name in the bem classification

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited from

UIList.getFullElName

Defined inDefined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

ParametersParameters

Name	Type
elementName	string
mod	string

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited from

UIList.getFullElName

Defined inDefined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

ParametersParameters

Name	Type
elementName	string
mod	string
modValue	string | boolean

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited from

UIList.getFullElName

Defined inDefined in

src/core/component/component.ts#67

---

bindDestructbindDestruct

bindDestruct(component): this

Bind destructor to some View

ParametersParameters

Name	Type
component	IComponent<IViewBased<IViewOptions>>

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.bindDestruct

Inherited fromInherited from

UIList.bindDestruct

Defined inDefined in

src/core/component/component.ts#170

---

setStatussetStatus

setStatus(componentStatus): void

Set component status

ParametersParameters

Name	Type	Description
componentStatus	ComponentStatus	component status

ReturnsReturns

void

See

ComponentStatus

Implementation ofImplementation of

IToolbarCollection.setStatus

Inherited fromInherited from

UIList.setStatus

Defined inDefined in

src/core/component/component.ts#226

---

hookStatushookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

ParametersParameters

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

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.hookStatus

Inherited fromInherited from

UIList.hookStatus

Defined inDefined in

src/core/component/component.ts#265

---

isInstanceOfisInstanceOf

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

Type parametersType parameters

Name	Type
T	extends Component

ParametersParameters

Name	Type
c	unknown
constructorFunc	Function

ReturnsReturns

c is T

Inherited fromInherited from

UIList.isInstanceOf

Defined inDefined in

src/core/component/component.ts#283

---

i18ni18n

i18n(text, ...params): string

ParametersParameters

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

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.i18n

Inherited fromInherited from

UIList.i18n

Defined inDefined in

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

---

setParentViewsetParentView

setParentView(jodit): this

Attach component to View

ParametersParameters

Name	Type
jodit	T

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.setParentView

Inherited fromInherited from

UIList.setParentView

Defined inDefined in

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

---

getElmgetElm

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

Return element with BEM class name

Type parametersType parameters

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

ParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturns

Nullable<HTMLElement>

Implementation ofImplementation of

IToolbarCollection.getElm

Inherited fromInherited from

UIList.getElm

Defined inDefined in

src/core/traits/elms.ts#18

---

getElmsgetElms

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

Return elements with BEM class name

Type parametersType parameters

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

ParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturns

HTMLElement[]

Implementation ofImplementation of

IToolbarCollection.getElms

Inherited fromInherited from

UIList.getElms

Defined inDefined in

src/core/traits/elms.ts#30

---

setModsetMod

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

Set/remove BEM class modification

Type parametersType parameters

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

ParametersParameters

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

ReturnsReturns

T

Implementation ofImplementation of

IToolbarCollection.setMod

Inherited fromInherited from

UIList.setMod

Defined inDefined in

src/core/traits/mods.ts#30

---

getModgetMod

getMod(this, name): ModType

Get BEM class modification value

ParametersParameters

Name	Type
this	IMods
name	string

ReturnsReturns

ModType

Implementation ofImplementation of

IToolbarCollection.getMod

Inherited fromInherited from

UIList.getMod

Defined inDefined in

src/core/traits/mods.ts#64

---

bubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.bubble

Inherited fromInherited from

UIList.bubble

Defined inDefined in

src/core/ui/element.ts#51

---

updateParentElementupdateParentElement

updateParentElement(target): this

ParametersParameters

Name	Type
target	IUIElement

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.updateParentElement

Inherited fromInherited from

UIList.updateParentElement

Defined inDefined in

src/core/ui/element.ts#62

---

getget

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

Type parametersType parameters

Name
T

ParametersParameters

Name	Type
chain	string
obj?	IDictionary

ReturnsReturns

Nullable<T>

Implementation ofImplementation of

IToolbarCollection.get

Inherited fromInherited from

UIList.get

Defined inDefined in

src/core/ui/element.ts#68

---

closestclosest

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

Find match parent

Type parametersType parameters

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

ParametersParameters

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

ReturnsReturns

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

Implementation ofImplementation of

IToolbarCollection.closest

Inherited fromInherited from

UIList.closest

Defined inDefined in

src/core/ui/element.ts#75

---

closestElementclosestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

ParametersParameters

Name	Type
node	Node
type	Function

ReturnsReturns

Nullable<IUIElement>

Inherited fromInherited from

UIList.closestElement

Defined inDefined in

src/core/ui/element.ts#106

---

appendToappendTo

appendTo(element): this

Append container to element

ParametersParameters

Name	Type
element	HTMLElement

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.appendTo

Inherited fromInherited from

UIList.appendTo

Defined inDefined in

src/core/ui/element.ts#131

---

appendappend

append(elm, distElement?): this

Append new element into group

ParametersParameters

Name	Type
elm	IUIElement | IUIElement[]
distElement?	string

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.append

Inherited fromInherited from

UIList.append

Defined inDefined in

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

---

afterSetModafterSetMod

afterSetMod(name, value): void

ParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.afterSetMod

Inherited fromInherited from

UIList.afterSetMod

Defined inDefined in

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

---

removeremove

remove(elm): this

Remove element from group

ParametersParameters

Name	Type
elm	IUIElement

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.remove

Inherited fromInherited from

UIList.remove

Defined inDefined in

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

---

clearclear

clear(): this

Clear group

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.clear

Inherited fromInherited from

UIList.clear

Defined inDefined in

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

---

getButtonsNamesgetButtonsNames

getButtonsNames(): string[]

Helper for getting full plain button list

ReturnsReturns

string[]

Implementation ofImplementation of

IToolbarCollection.getButtonsNames

Inherited fromInherited from

UIList.getButtonsNames

Defined inDefined in

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

---

setRemoveButtonssetRemoveButtons

setRemoveButtons(removeButtons?): this

ParametersParameters

Name	Type
removeButtons?	string[]

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.setRemoveButtons

Inherited fromInherited from

UIList.setRemoveButtons

Defined inDefined in

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

---

classNameclassName

className(): string

ReturnsReturns

string

Implementation ofImplementation of

IToolbarCollection.className

OverridesOverrides

UIList.className

Defined inDefined in

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

---

shouldBeActiveshouldBeActive

shouldBeActive(button): undefined | boolean

Button should be active

ParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturns

undefined | boolean

Implementation ofImplementation of

IToolbarCollection.shouldBeActive

Defined inDefined in

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

---

shouldBeDisabledshouldBeDisabled

shouldBeDisabled(button): undefined | boolean

The Button should be disabled

ParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturns

undefined | boolean

Implementation ofImplementation of

IToolbarCollection.shouldBeDisabled

Defined inDefined in

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

---

getTargetgetTarget

getTarget(button): null | Node

Returns current target for button

ParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturns

null | Node

Implementation ofImplementation of

IToolbarCollection.getTarget

Defined inDefined in

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

---

updateupdate

update(): void

Update all children

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.update

OverridesOverrides

UIList.update

Defined inDefined in

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

---

setDirectionsetDirection

setDirection(direction): void

Set direction

ParametersParameters

Name	Type
direction	"rtl" | "ltr"

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.setDirection

Defined inDefined in

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

---

hidehide

hide(): void

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.hide

Defined inDefined in

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

---

showshow

show(): void

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.show

Defined inDefined in

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

---

showInlineshowInline

showInline(bound?): void

ParametersParameters

Name	Type
bound?	IBound

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.showInline

Defined inDefined in

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

---

buildbuild

build(items, target?): this

ParametersParameters

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

ReturnsReturns

this

Implementation ofImplementation of

IToolbarCollection.build

OverridesOverrides

UIList.build

Defined inDefined in

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

---

destructdestruct

destruct(): void

ReturnsReturns

void

Implementation ofImplementation of

IToolbarCollection.destruct

OverridesOverrides

UIList.destruct

Defined inDefined in

jodit/src/modules/toolbar/collection/collection.ts:157