ToolbarCollection
- Type parameters
- Hierarchy
- Implements
- constructor
- STATUSES
- async
- uid
- ownerWindow
- container
- name
- mods
- syncMod
- elements
- buttonSize
- options
- jodit
- mode
- componentName
- ownerDocument
- od
- ow
- isReady
- isDestructed
- isInDestruct
- componentStatus
- j
- defaultTimeout
- parentElement
- allChildren
- buttons
- firstButton
- getFullElName
- bindDestruct
- setStatus
- hookStatus
- isInstanceOf
- i18n
- setParentView
- getElm
- getElms
- setMod
- getMod
- bubble
- updateParentElement
- get
- closest
- closestElement
- appendTo
- append
- afterSetMod
- remove
- clear
- getButtonsNames
- setRemoveButtons
- className
- shouldBeActive
- shouldBeDisabled
- getTarget
- update
- setDirection
- hide
- show
- showInline
- build
- destruct
modules/toolbar/collection.ToolbarCollection
The base class of all Jodit UI components. Provides work with a life cycle.
Type parameters
Name | Type |
---|---|
T |
extends IViewWithToolbar = IViewWithToolbar |
Hierarchy
-
UIList
<T
>↳
ToolbarCollection
↳↳
ToolbarEditorCollection
Implements
constructor
new ToolbarCollection<T
>(jodit
): ToolbarCollection
<T
>
Type parameters
Name | Type |
---|---|
T |
extends IViewWithToolbar <IViewOptions > = IViewWithToolbar <IViewOptions > |
Parameters
Name | Type |
---|---|
jodit |
IViewBased <IViewOptions > |
Returns
Overrides
Defined in
src/modules/toolbar/collection/collection.ts#115
STATUSES
Static
STATUSES: Object
= STATUSES
Type declaration
Name | Type |
---|---|
beforeInit |
"beforeInit" |
ready |
"ready" |
beforeDestruct |
"beforeDestruct" |
destructed |
"destructed" |
Inherited from
Defined in
src/core/component/component.ts#40
async
async: IAsync
Implementation of
Inherited from
Defined in
src/core/component/component.ts#44
uid
Readonly
uid: string
Implementation of
Inherited from
Defined in
src/core/component/component.ts#59
ownerWindow
ownerWindow: Window
= window
The window in which jodit was created
Implementation of
IToolbarCollection.ownerWindow
Inherited from
Defined in
src/core/component/component.ts#109
container
container: HTMLElement
Implementation of
Inherited from
Defined in
name
name: string
= ''
Implementation of
Inherited from
Defined in
mods
Readonly
mods: IDictionary
<null
| string
| boolean
> = {}
Implementation of
Inherited from
Defined in
syncMod
syncMod: boolean
= false
Synchronize mods to all children
Inherited from
Defined in
elements
elements: IUIElement
[] = []
Implementation of
Inherited from
Defined in
buttonSize
buttonSize: "small"
| "tiny"
| "xsmall"
| "middle"
| "large"
= 'middle'
Implementation of
Inherited from
Defined in
options
Optional
Readonly
options: IDictionary
Inherited from
Defined in
src/core/ui/group/group.ts#155
jodit
jodit: T
Parent View element
Implementation of
Inherited from
Defined in
mode
mode: "vertical"
| "horizontal"
= 'horizontal'
Implementation of
Inherited from
Defined in
componentName
get
componentName(): string
Returns
string
Implementation of
IToolbarCollection.componentName
Inherited from
UIList.componentName
Defined in
src/core/component/component.ts#46
ownerDocument
get
ownerDocument(): Document
The document in which jodit was created
Returns
Implementation of
IToolbarCollection.ownerDocument
Inherited from
UIList.ownerDocument
Defined in
src/core/component/component.ts#95
od
get
od(): Document
Shortcut for this.ownerDocument
Returns
Implementation of
Inherited from
UIList.od
Defined in
src/core/component/component.ts#102
ow
get
ow(): Window
Returns
Implementation of
Inherited from
UIList.ow
Defined in
src/core/component/component.ts#110
isReady
get
isReady(): boolean
Component is ready for work
Returns
boolean
Implementation of
Inherited from
UIList.isReady
Defined in
src/core/component/component.ts#145
isDestructed
get
isDestructed(): boolean
Component was destructed
Returns
boolean
Implementation of
IToolbarCollection.isDestructed
Inherited from
UIList.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
IToolbarCollection.isInDestruct
Inherited from
UIList.isInDestruct
Defined in
src/core/component/component.ts#160
componentStatus
get
componentStatus(): ComponentStatus
Current component status
Returns
Implementation of
IToolbarCollection.componentStatus
Inherited from
UIList.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
IToolbarCollection.componentStatus
Inherited from
UIList.componentStatus
Defined in
src/core/component/component.ts#217
j
get
j(): T
Shortcut for this.jodit
Returns
T
Implementation of
Inherited from
UIList.j
Defined in
src/core/component/view-component.ts#27
defaultTimeout
get
defaultTimeout(): number
Returns
number
Implementation of
IToolbarCollection.defaultTimeout
Inherited from
UIList.defaultTimeout
Defined in
src/core/component/view-component.ts#31
parentElement
get
parentElement(): Nullable
<IUIElement
>
Returns
Implementation of
IToolbarCollection.parentElement
Inherited from
UIList.parentElement
Defined in
set
parentElement(parentElement
): void
Parameters
Name | Type |
---|---|
parentElement |
Nullable <IUIElement > |
Returns
void
Implementation of
IToolbarCollection.parentElement
Inherited from
UIList.parentElement
Defined in
allChildren
get
allChildren(): IUIElement
[]
All group children
Returns
Implementation of
IToolbarCollection.allChildren
Inherited from
UIList.allChildren
Defined in
buttons
get
buttons(): IUIButton
[]
All buttons from list
Returns
Implementation of
Inherited from
UIList.buttons
Defined in
firstButton
get
firstButton(): Nullable
<IToolbarButton
>
First button in a list
Returns
Implementation of
IToolbarCollection.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
Implementation of
IToolbarCollection.getFullElName
Inherited from
Defined in
src/core/component/component.ts#65
getFullElName(elementName
, mod
): string
Parameters
Name | Type |
---|---|
elementName |
string |
mod |
string |
Returns
string
Implementation of
IToolbarCollection.getFullElName
Inherited from
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
IToolbarCollection.getFullElName
Inherited from
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
Implementation of
IToolbarCollection.bindDestruct
Inherited from
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
Implementation of
Inherited from
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
Inherited from
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
Defined in
src/core/component/component.ts#283
i18n
i18n(text
, ...params
): string
Parameters
Name | Type |
---|---|
text |
string |
...params |
(string | number )[] |
Returns
string
Implementation of
Inherited from
Defined in
src/core/component/view-component.ts#35
setParentView
setParentView(jodit
): this
Attach component to View
Parameters
Name | Type |
---|---|
jodit |
T |
Returns
this
Implementation of
IToolbarCollection.setParentView
Inherited from
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
Implementation of
Inherited from
Defined in
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
Implementation of
Inherited from
Defined in
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
Inherited from
Defined in
getMod
getMod(this
, name
): ModType
Get BEM class modification value
Parameters
Name | Type |
---|---|
this |
IMods |
name |
string |
Returns
Implementation of
Inherited from
Defined in
bubble
bubble(callback
): this
Apply callback for all parents
Parameters
Name | Type |
---|---|
callback |
(parent : IUIElement ) => void |
Returns
this
Implementation of
Inherited from
Defined in
updateParentElement
updateParentElement(target
): this
Parameters
Name | Type |
---|---|
target |
IUIElement |
Returns
this
Implementation of
IToolbarCollection.updateParentElement
Inherited from
Defined in
get
get<T
>(chain
, obj?
): Nullable
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
chain |
string |
obj? |
IDictionary |
Returns
Nullable
<T
>
Implementation of
Inherited from
Defined in
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
>
Implementation of
Inherited from
Defined in
closestElement
closestElement(node
, type
): Nullable
<IUIElement
>
Find closest UIElement in DOM
Parameters
Name | Type |
---|---|
node |
Node |
type |
Function |
Returns
Inherited from
Defined in
appendTo
appendTo(element
): this
Append container to element
Parameters
Name | Type |
---|---|
element |
HTMLElement |
Returns
this
Implementation of
Inherited from
Defined in
append
append(elm
, distElement?
): this
Append new element into group
Parameters
Name | Type |
---|---|
elm |
IUIElement | IUIElement [] |
distElement? |
string |
Returns
this
Implementation of
Inherited from
Defined in
afterSetMod
afterSetMod(name
, value
): void
Parameters
Name | Type |
---|---|
name |
string |
value |
ModType |
Returns
void
Implementation of
IToolbarCollection.afterSetMod
Inherited from
Defined in
src/core/ui/group/group.ts#111
remove
remove(elm
): this
Remove element from group
Parameters
Name | Type |
---|---|
elm |
IUIElement |
Returns
this
Implementation of
Inherited from
Defined in
src/core/ui/group/group.ts#127
clear
clear(): this
Clear group
Returns
this
Implementation of
Inherited from
Defined in
src/core/ui/group/group.ts#142
getButtonsNames
getButtonsNames(): string
[]
Helper for getting full plain button list
Returns
string
[]
Implementation of
IToolbarCollection.getButtonsNames
Inherited from
Defined in
setRemoveButtons
setRemoveButtons(removeButtons?
): this
Parameters
Name | Type |
---|---|
removeButtons? |
string [] |
Returns
this
Implementation of
IToolbarCollection.setRemoveButtons
Inherited from
Defined in
className
className(): string
Returns
string
Implementation of
Overrides
Defined in
src/modules/toolbar/collection/collection.ts#38
shouldBeActive
shouldBeActive(button
): undefined
| boolean
Button should be active
Parameters
Name | Type |
---|---|
button |
IToolbarButton |
Returns
undefined
| boolean
Implementation of
IToolbarCollection.shouldBeActive
Defined in
src/modules/toolbar/collection/collection.ts#71
shouldBeDisabled
shouldBeDisabled(button
): undefined
| boolean
The Button should be disabled
Parameters
Name | Type |
---|---|
button |
IToolbarButton |
Returns
undefined
| boolean
Implementation of
IToolbarCollection.shouldBeDisabled
Defined in
src/modules/toolbar/collection/collection.ts#78
getTarget
getTarget(button
): null
| Node
Returns current target for button
Parameters
Name | Type |
---|---|
button |
IToolbarButton |
Returns
null
| Node
Implementation of
Defined in
src/modules/toolbar/collection/collection.ts#85
update
update(): void
Update all children
Returns
void
Implementation of
Overrides
Defined in
src/modules/toolbar/collection/collection.ts#101
setDirection
setDirection(direction
): void
Set direction
Parameters
Name | Type |
---|---|
direction |
"rtl" | "ltr" |
Returns
void
Implementation of
IToolbarCollection.setDirection
Defined in
src/modules/toolbar/collection/collection.ts#108
hide
hide(): void
Returns
void
Implementation of
Defined in
src/modules/toolbar/collection/collection.ts#126
show
show(): void
Returns
void
Implementation of
Defined in
src/modules/toolbar/collection/collection.ts#130
showInline
showInline(bound?
): void
Parameters
Name | Type |
---|---|
bound? |
IBound |
Returns
void
Implementation of
Defined in
src/modules/toolbar/collection/collection.ts#134
build
build(items
, target?
): this
Parameters
Name | Type | Default value |
---|---|---|
items |
ButtonsGroups |
undefined |
target |
Nullable <HTMLElement > |
null |
Returns
this
Implementation of
Overrides
Defined in
src/modules/toolbar/collection/collection.ts#139
destruct
destruct(): void
Returns
void
Implementation of
Overrides
Defined in
jodit/src/modules/toolbar/collection/collection.ts:157