IToolbarCollection | Jodit Editor - v3.24.5

Hierarchy

IUIList
- IToolbarCollection

Implemented by

ToolbarCollection

Methods

afterSetMod

afterSetMod(name: string, value: ModType): void
Parameters
- name: string
- value: ModType
Returns void

append

append(elm: IUIElement | IUIElement[], distElement?: string): IToolbarCollection
Parameters
- elm: IUIElement | IUIElement[]
- Optional distElement: string
Returns IToolbarCollection

appendTo

appendTo(element: HTMLElement): IToolbarCollection
Parameters
- element: HTMLElement
Returns IToolbarCollection

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): IToolbarCollection
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns IToolbarCollection

bubble

bubble(callback: ((parent: IUIElement) => void)): IToolbarCollection
Apply callback for all parents
Parameters
- callback: ((parent: IUIElement) => void)
  - - (parent: IUIElement): void
    - Parameters
      
      parent: IUIElement
      
      Returns void
Returns IToolbarCollection

build

build(items: ButtonsOption, target?: Nullable<HTMLElement>): IUIList
Parameters
- items: ButtonsOption
- Optional target: Nullable<HTMLElement>
Returns IUIList

className

className(): string
Returns string

clear

clear(): IToolbarCollection
Returns IToolbarCollection

closest

closest<T>(type: Function): Nullable<T>
Type Parameters
- T extends IUIElement<T>
Parameters
- type: Function
Returns Nullable<T>
closest<T>(type: Function | T): Nullable<T>
Type Parameters
- T extends IUIElement<T>
Parameters
- type: Function | T
Returns Nullable<T>

destruct

destruct(jodit?: IViewBased<IViewOptions>): any
Parameters
- Optional jodit: IViewBased<IViewOptions>
Returns any

get

get<T>(chain: string, obj?: IDictionary<any, string>): Nullable<T>
Type Parameters
- T
Parameters
- chain: string
- Optional obj: IDictionary<any, string>
Returns Nullable<T>

getButtonsNames

getButtonsNames(): string[]
Returns string[]

getElm

getElm(elementName: string): Nullable<HTMLElement>
Parameters
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms(elementName: string): HTMLElement[]
Parameters
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Parameters
- elementName: string
Returns string
getFullElName(elementName: string, mod: string): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName: string, mod?: string, modValue?: string | boolean): string
Parameters
- elementName: string
- Optional mod: string
- Optional modValue: string | boolean
Returns string

getMod

getMod(name: string): ModType
Parameters
- name: string
Returns ModType

getTarget

getTarget(button: IToolbarButton): null | Node
Parameters
- button: IToolbarButton
Returns null | Node

hide

hide(): void
Returns void

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: IToolbarCollection) => void)): void
Parameters
- status: ComponentStatus
- callback: ((component: IToolbarCollection) => void)
  - - (component: IToolbarCollection): void
    - Parameters
      
      component: IToolbarCollection
      
      Returns void
Returns void

remove

remove(elm: IUIElement): IToolbarCollection
Parameters
- elm: IUIElement
Returns IToolbarCollection

setDirection

setDirection(direction: "rtl" | "ltr"): void
Parameters
- direction: "rtl" | "ltr"
Returns void

setMod

setMod<T>(this: T, name: string, value: ModType): T
Set/remove modification (null - remove)
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
Returns T

setParentView

setParentView(jodit: IViewBased<IViewOptions>): IToolbarCollection
Parameters
- jodit: IViewBased<IViewOptions>
Returns IToolbarCollection

setRemoveButtons

setRemoveButtons(removeButtons?: string[]): IToolbarCollection
Parameters
- Optional removeButtons: string[]
Returns IToolbarCollection

setStatus

setStatus(componentStatus: ComponentStatus): void
Parameters
- componentStatus: ComponentStatus
Returns void

shouldBeActive

shouldBeActive(button: IToolbarButton): boolean | void
Parameters
- button: IToolbarButton
Returns boolean | void

shouldBeDisabled

shouldBeDisabled(button: IToolbarButton): boolean | void
Parameters
- button: IToolbarButton
Returns boolean | void

show

show(): void
Returns void

showInline

showInline(bound?: IBound): void
Parameters
- Optional bound: IBound
Returns void

update

update(): void
Returns void

updateParentElement

updateParentElement(target: IUIElement): IToolbarCollection
Parameters
- target: IUIElement
Returns IToolbarCollection

Properties

allChildren

allChildren: IUIElement[]

`Readonly` async

async: IAsync

buttonSize

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

buttons

buttons: IUIButton[]

`Readonly` componentName

componentName: string

`Readonly` componentStatus

componentStatus: ComponentStatus

container

container: HTMLElement

`Readonly` defaultTimeout

defaultTimeout: number

elements

elements: IUIElement[]

firstButton

firstButton: Nullable<IToolbarButton>

`Readonly` i18n

i18n: ((text: string, ...params: (string | number)[]) => string)

Type declaration

- (text: string, ...params: (string | number)[]): string
- Parameters
  - text: string
  - Rest ...params: (string | number)[]
  Returns string

`Readonly` isDestructed

isDestructed: boolean

`Readonly` isInDestruct

isInDestruct: boolean

`Readonly` isReady

isReady: boolean

`Readonly` j

j: IViewBased<IViewOptions>

jodit

jodit: IViewBased<IViewOptions>

mode

mode: "vertical" | "horizontal"

mods

mods: IDictionary<ModType, string>

name

name: string

`Readonly` od

`Readonly` ow

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` ownerWindow

ownerWindow: Window

parentElement

parentElement: Nullable<IUIElement>

`Readonly` uid

uid: string

Jodit PRO

If you like Jodit - try Jodit PRO