ToolbarCollection

modules/toolbar/collection.ToolbarCollection

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

Type parametersType parametersType parameters

Name	Type
T	extends IViewWithToolbar = IViewWithToolbar

HierarchyHierarchyHierarchy

• UIList<T>

  ↳ ToolbarCollection

  ↳↳ ToolbarEditorCollection

ImplementsImplementsImplements

• IToolbarCollection

constructorconstructorconstructor

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

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturnsReturns

ToolbarCollection<T>

OverridesOverridesOverrides

UIList.constructor

Defined inDefined inDefined in

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

STATUSESSTATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declarationType declaration

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

Inherited fromInherited fromInherited from

UIList.STATUSES

Defined inDefined inDefined in

src/core/component/component.ts#40

---

asyncasyncasync

async: IAsync

Implementation ofImplementation ofImplementation of

IToolbarCollection.async

Inherited fromInherited fromInherited from

UIList.async

Defined inDefined inDefined in

src/core/component/component.ts#44

---

uiduiduid

Readonly uid: string

Implementation ofImplementation ofImplementation of

IToolbarCollection.uid

Inherited fromInherited fromInherited from

UIList.uid

Defined inDefined inDefined in

src/core/component/component.ts#59

---

ownerWindowownerWindowownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation ofImplementation ofImplementation of

IToolbarCollection.ownerWindow

Inherited fromInherited fromInherited from

UIList.ownerWindow

Defined inDefined inDefined in

src/core/component/component.ts#109

---

containercontainercontainer

container: HTMLElement

Implementation ofImplementation ofImplementation of

IToolbarCollection.container

Inherited fromInherited fromInherited from

UIList.container

Defined inDefined inDefined in

src/core/ui/element.ts#32

---

namenamename

name: string = ''

Implementation ofImplementation ofImplementation of

IToolbarCollection.name

Inherited fromInherited fromInherited from

UIList.name

Defined inDefined inDefined in

src/core/ui/element.ts#33

---

modsmodsmods

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

Implementation ofImplementation ofImplementation of

IToolbarCollection.mods

Inherited fromInherited fromInherited from

UIList.mods

Defined inDefined inDefined in

src/core/ui/element.ts#119

---

syncModsyncModsyncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited fromInherited fromInherited from

UIList.syncMod

Defined inDefined inDefined in

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

---

elementselementselements

elements: IUIElement[] = []

Implementation ofImplementation ofImplementation of

IToolbarCollection.elements

Inherited fromInherited fromInherited from

UIList.elements

Defined inDefined inDefined in

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

---

buttonSizebuttonSizebuttonSize

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

Implementation ofImplementation ofImplementation of

IToolbarCollection.buttonSize

Inherited fromInherited fromInherited from

UIList.buttonSize

Defined inDefined inDefined in

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

---

optionsoptionsoptions

Optional Readonly options: IDictionary

Inherited fromInherited fromInherited from

UIList.options

Defined inDefined inDefined in

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

---

joditjoditjodit

jodit: T

Parent View element

Implementation ofImplementation ofImplementation of

IToolbarCollection.jodit

Inherited fromInherited fromInherited from

UIList.jodit

Defined inDefined inDefined in

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

---

modemodemode

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

Implementation ofImplementation ofImplementation of

IToolbarCollection.mode

Inherited fromInherited fromInherited from

UIList.mode

Defined inDefined inDefined in

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

componentNamecomponentNamecomponentName

get componentName(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.componentName

Inherited fromInherited fromInherited from

UIList.componentName

Defined inDefined inDefined in

src/core/component/component.ts#46

---

ownerDocumentownerDocumentownerDocument

get ownerDocument(): Document

The document in which jodit was created

ReturnsReturnsReturns

Document

Implementation ofImplementation ofImplementation of

IToolbarCollection.ownerDocument

Inherited fromInherited fromInherited from

UIList.ownerDocument

Defined inDefined inDefined in

src/core/component/component.ts#95

---

ododod

get od(): Document

Shortcut for this.ownerDocument

ReturnsReturnsReturns

Document

Implementation ofImplementation ofImplementation of

IToolbarCollection.od

Inherited fromInherited fromInherited from

UIList.od

Defined inDefined inDefined in

src/core/component/component.ts#102

---

owowow

get ow(): Window

ReturnsReturnsReturns

Window

Implementation ofImplementation ofImplementation of

IToolbarCollection.ow

Inherited fromInherited fromInherited from

UIList.ow

Defined inDefined inDefined in

src/core/component/component.ts#110

---

isReadyisReadyisReady

get isReady(): boolean

Component is ready for work

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IToolbarCollection.isReady

Inherited fromInherited fromInherited from

UIList.isReady

Defined inDefined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IToolbarCollection.isDestructed

Inherited fromInherited fromInherited from

UIList.isDestructed

Defined inDefined inDefined in

src/core/component/component.ts#152

---

isInDestructisInDestructisInDestruct

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.

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IToolbarCollection.isInDestruct

Inherited fromInherited fromInherited from

UIList.isInDestruct

Defined inDefined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturnsReturns

ComponentStatus

Implementation ofImplementation ofImplementation of

IToolbarCollection.componentStatus

Inherited fromInherited fromInherited from

UIList.componentStatus

Defined inDefined inDefined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

ParametersParametersParameters

Name	Type
componentStatus	ComponentStatus

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.componentStatus

Inherited fromInherited fromInherited from

UIList.componentStatus

Defined inDefined inDefined in

src/core/component/component.ts#217

---

jjj

get j(): T

Shortcut for this.jodit

ReturnsReturnsReturns

T

Implementation ofImplementation ofImplementation of

IToolbarCollection.j

Inherited fromInherited fromInherited from

UIList.j

Defined inDefined inDefined in

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

---

defaultTimeoutdefaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IToolbarCollection.defaultTimeout

Inherited fromInherited fromInherited from

UIList.defaultTimeout

Defined inDefined inDefined in

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

---

parentElementparentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation ofImplementation of

IToolbarCollection.parentElement

Inherited fromInherited fromInherited from

UIList.parentElement

Defined inDefined inDefined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

ParametersParametersParameters

Name	Type
parentElement	Nullable<IUIElement>

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.parentElement

Inherited fromInherited fromInherited from

UIList.parentElement

Defined inDefined inDefined in

src/core/ui/element.ts#41

---

allChildrenallChildrenallChildren

get allChildren(): IUIElement[]

All group children

ReturnsReturnsReturns

IUIElement[]

Implementation ofImplementation ofImplementation of

IToolbarCollection.allChildren

Inherited fromInherited fromInherited from

UIList.allChildren

Defined inDefined inDefined in

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

---

buttonsbuttonsbuttons

get buttons(): IUIButton[]

All buttons from list

ReturnsReturnsReturns

IUIButton[]

Implementation ofImplementation ofImplementation of

IToolbarCollection.buttons

Inherited fromInherited fromInherited from

UIList.buttons

Defined inDefined inDefined in

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

---

firstButtonfirstButtonfirstButton

get firstButton(): Nullable<IToolbarButton>

First button in a list

ReturnsReturnsReturns

Nullable<IToolbarButton>

Implementation ofImplementation ofImplementation of

IToolbarCollection.firstButton

Defined inDefined inDefined in

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

getFullElNamegetFullElNamegetFullElName

getFullElName(elementName): string

Calc BEM element class name

ParametersParametersParameters

Name	Type	Description
elementName	string	element name in the bem classification

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited fromInherited from

UIList.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

ParametersParametersParameters

Name	Type
elementName	string
mod	string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited fromInherited from

UIList.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

ParametersParametersParameters

Name	Type
elementName	string
mod	string
modValue	string | boolean

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.getFullElName

Inherited fromInherited fromInherited from

UIList.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#67

---

bindDestructbindDestructbindDestruct

bindDestruct(component): this

Bind destructor to some View

ParametersParametersParameters

Name	Type
component	IComponent<IViewBased<IViewOptions>>

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.bindDestruct

Inherited fromInherited fromInherited from

UIList.bindDestruct

Defined inDefined inDefined in

src/core/component/component.ts#170

---

setStatussetStatussetStatus

setStatus(componentStatus): void

Set component status

ParametersParametersParameters

Name	Type	Description
componentStatus	ComponentStatus	component status

ReturnsReturnsReturns

void

See

ComponentStatus

Implementation ofImplementation ofImplementation of

IToolbarCollection.setStatus

Inherited fromInherited fromInherited from

UIList.setStatus

Defined inDefined inDefined in

src/core/component/component.ts#226

---

hookStatushookStatushookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

ParametersParametersParameters

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

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.hookStatus

Inherited fromInherited fromInherited from

UIList.hookStatus

Defined inDefined inDefined in

src/core/component/component.ts#265

---

isInstanceOfisInstanceOfisInstanceOf

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

Type parametersType parametersType parameters

Name	Type
T	extends Component

ParametersParametersParameters

Name	Type
c	unknown
constructorFunc	Function

ReturnsReturnsReturns

c is T

Inherited fromInherited fromInherited from

UIList.isInstanceOf

Defined inDefined inDefined in

src/core/component/component.ts#283

---

i18ni18ni18n

i18n(text, ...params): string

ParametersParametersParameters

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

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.i18n

Inherited fromInherited fromInherited from

UIList.i18n

Defined inDefined inDefined in

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

---

setParentViewsetParentViewsetParentView

setParentView(jodit): this

Attach component to View

ParametersParametersParameters

Name	Type
jodit	T

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.setParentView

Inherited fromInherited fromInherited from

UIList.setParentView

Defined inDefined inDefined in

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

---

getElmgetElmgetElm

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

Return element with BEM class name

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturnsReturns

Nullable<HTMLElement>

Implementation ofImplementation ofImplementation of

IToolbarCollection.getElm

Inherited fromInherited fromInherited from

UIList.getElm

Defined inDefined inDefined in

src/core/traits/elms.ts#18

---

getElmsgetElmsgetElms

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

Return elements with BEM class name

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturnsReturns

HTMLElement[]

Implementation ofImplementation ofImplementation of

IToolbarCollection.getElms

Inherited fromInherited fromInherited from

UIList.getElms

Defined inDefined inDefined in

src/core/traits/elms.ts#30

---

setModsetModsetMod

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

Set/remove BEM class modification

Type parametersType parametersType parameters

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

ParametersParametersParameters

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

ReturnsReturnsReturns

T

Implementation ofImplementation ofImplementation of

IToolbarCollection.setMod

Inherited fromInherited fromInherited from

UIList.setMod

Defined inDefined inDefined in

src/core/traits/mods.ts#30

---

getModgetModgetMod

getMod(this, name): ModType

Get BEM class modification value

ParametersParametersParameters

Name	Type
this	IMods
name	string

ReturnsReturnsReturns

ModType

Implementation ofImplementation ofImplementation of

IToolbarCollection.getMod

Inherited fromInherited fromInherited from

UIList.getMod

Defined inDefined inDefined in

src/core/traits/mods.ts#64

---

bubblebubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.bubble

Inherited fromInherited fromInherited from

UIList.bubble

Defined inDefined inDefined in

src/core/ui/element.ts#51

---

updateParentElementupdateParentElementupdateParentElement

updateParentElement(target): this

ParametersParametersParameters

Name	Type
target	IUIElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.updateParentElement

Inherited fromInherited fromInherited from

UIList.updateParentElement

Defined inDefined inDefined in

src/core/ui/element.ts#62

---

getgetget

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

Type parametersType parametersType parameters

Name
T

ParametersParametersParameters

Name	Type
chain	string
obj?	IDictionary

ReturnsReturnsReturns

Nullable<T>

Implementation ofImplementation ofImplementation of

IToolbarCollection.get

Inherited fromInherited fromInherited from

UIList.get

Defined inDefined inDefined in

src/core/ui/element.ts#68

---

closestclosestclosest

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

Find match parent

Type parametersType parametersType parameters

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

ParametersParametersParameters

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

ReturnsReturnsReturns

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

Implementation ofImplementation ofImplementation of

IToolbarCollection.closest

Inherited fromInherited fromInherited from

UIList.closest

Defined inDefined inDefined in

src/core/ui/element.ts#75

---

closestElementclosestElementclosestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

ParametersParametersParameters

Name	Type
node	Node
type	Function

ReturnsReturnsReturns

Nullable<IUIElement>

Inherited fromInherited fromInherited from

UIList.closestElement

Defined inDefined inDefined in

src/core/ui/element.ts#106

---

appendToappendToappendTo

appendTo(element): this

Append container to element

ParametersParametersParameters

Name	Type
element	HTMLElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.appendTo

Inherited fromInherited fromInherited from

UIList.appendTo

Defined inDefined inDefined in

src/core/ui/element.ts#131

---

appendappendappend

append(elm, distElement?): this

Append new element into group

ParametersParametersParameters

Name	Type
elm	IUIElement | IUIElement[]
distElement?	string

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.append

Inherited fromInherited fromInherited from

UIList.append

Defined inDefined inDefined in

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

---

afterSetModafterSetModafterSetMod

afterSetMod(name, value): void

ParametersParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.afterSetMod

Inherited fromInherited fromInherited from

UIList.afterSetMod

Defined inDefined inDefined in

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

---

removeremoveremove

remove(elm): this

Remove element from group

ParametersParametersParameters

Name	Type
elm	IUIElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.remove

Inherited fromInherited fromInherited from

UIList.remove

Defined inDefined inDefined in

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

---

clearclearclear

clear(): this

Clear group

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.clear

Inherited fromInherited fromInherited from

UIList.clear

Defined inDefined inDefined in

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

---

getButtonsNamesgetButtonsNamesgetButtonsNames

getButtonsNames(): string[]

Helper for getting full plain button list

ReturnsReturnsReturns

string[]

Implementation ofImplementation ofImplementation of

IToolbarCollection.getButtonsNames

Inherited fromInherited fromInherited from

UIList.getButtonsNames

Defined inDefined inDefined in

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

---

setRemoveButtonssetRemoveButtonssetRemoveButtons

setRemoveButtons(removeButtons?): this

ParametersParametersParameters

Name	Type
removeButtons?	string[]

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.setRemoveButtons

Inherited fromInherited fromInherited from

UIList.setRemoveButtons

Defined inDefined inDefined in

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

---

classNameclassNameclassName

className(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IToolbarCollection.className

OverridesOverridesOverrides

UIList.className

Defined inDefined inDefined in

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

---

shouldBeActiveshouldBeActiveshouldBeActive

shouldBeActive(button): undefined | boolean

Button should be active

ParametersParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturnsReturns

undefined | boolean

Implementation ofImplementation ofImplementation of

IToolbarCollection.shouldBeActive

Defined inDefined inDefined in

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

---

shouldBeDisabledshouldBeDisabledshouldBeDisabled

shouldBeDisabled(button): undefined | boolean

The Button should be disabled

ParametersParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturnsReturns

undefined | boolean

Implementation ofImplementation ofImplementation of

IToolbarCollection.shouldBeDisabled

Defined inDefined inDefined in

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

---

getTargetgetTargetgetTarget

getTarget(button): null | Node

Returns current target for button

ParametersParametersParameters

Name	Type
button	IToolbarButton

ReturnsReturnsReturns

null | Node

Implementation ofImplementation ofImplementation of

IToolbarCollection.getTarget

Defined inDefined inDefined in

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

---

updateupdateupdate

update(): void

Update all children

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.update

OverridesOverridesOverrides

UIList.update

Defined inDefined inDefined in

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

---

setDirectionsetDirectionsetDirection

setDirection(direction): void

Set direction

ParametersParametersParameters

Name	Type
direction	"rtl" | "ltr"

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.setDirection

Defined inDefined inDefined in

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

---

hidehidehide

hide(): void

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.hide

Defined inDefined inDefined in

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

---

showshowshow

show(): void

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.show

Defined inDefined inDefined in

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

---

showInlineshowInlineshowInline

showInline(bound?): void

ParametersParametersParameters

Name	Type
bound?	IBound

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.showInline

Defined inDefined inDefined in

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

---

buildbuildbuild

build(items, target?): this

ParametersParametersParameters

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

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IToolbarCollection.build

OverridesOverridesOverrides

UIList.build

Defined inDefined inDefined in

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

---

destructdestructdestruct

destruct(): void

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IToolbarCollection.destruct

OverridesOverridesOverrides

UIList.destruct

Defined inDefined inDefined in

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