ToolbarButton | Jodit Editor

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

Type Parameters

T extends IViewBased = IViewBased

Hierarchy

UIButton
- ToolbarButton

Implements

IToolbarButton

Index

Constructors

constructor

new ToolbarButton<T>(jodit, control, target?): ToolbarButton<T>
Type Parameters
- T extends IViewBased<IViewOptions> = IViewBased<IViewOptions>
Parameters
- jodit: T
- control: IControlTypeStrong
- target: Nullable<HTMLElement> = null
Returns ToolbarButton<T>

Properties

`Static` STATUSES

STATUSES: {
    beforeDestruct: "beforeDestruct";
    beforeInit: "beforeInit";
    destructed: "destructed";
    ready: "ready";
} = STATUSES

Type declaration

Readonly beforeDestruct: "beforeDestruct"
Readonly beforeInit: "beforeInit"
Readonly destructed: "destructed"
Readonly ready: "ready"

async

async: IAsync = ...

container

container: HTMLElement

`Readonly` control

control: IControlTypeStrong

`Readonly` isButton

isButton: true = ...

Marker for buttons

jodit

jodit: IViewBased<IViewOptions>

Parent View element

`Readonly` mods

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

name

name: string = ''

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

`Readonly` state

state: {
    activated: boolean;
    currentValue: string;
    disabled: boolean;
    hasTrigger: boolean;
    icon: IUIIconState;
    name: string;
    size: "small" | "tiny" | "xsmall" | "middle" | "large";
    tabIndex: CanUndef<number>;
    text: string;
    theme: string;
    tooltip: string;
    type: "button" | "submit";
    value: string | number | boolean;
    variant: ButtonVariant;
} = ...

Type declaration

activated: boolean
currentValue: string
disabled: boolean
hasTrigger: boolean
icon: IUIIconState
name: string
size: "small" | "tiny" | "xsmall" | "middle" | "large"
tabIndex: CanUndef<number>
text: string
theme: string
tooltip: string
type: "button" | "submit"
value: string | number | boolean
variant: ButtonVariant

`Readonly` target

target: Nullable<HTMLElement> = null

`Readonly` uid

uid: string

Accessors

componentName

get componentName(): string
Returns string

componentStatus

get componentStatus(): ComponentStatus
Current component status

Returns ComponentStatus
set componentStatus(componentStatus): void
Setter for current component status
Parameters
- componentStatus: ComponentStatus
Returns void

defaultTimeout

get defaultTimeout(): number
Returns number

icon

get icon(): HTMLElement
DOM container for icon

Returns HTMLElement

isDestructed

get isDestructed(): boolean
Component was destructed

Returns boolean

isInDestruct

get isInDestruct(): boolean
The component is currently undergoing destructuring or has already been destroyed. Those. you should not hang new events on him now or do anything else with him.

Returns boolean

isReady

get isReady(): boolean
Component is ready for work

Returns boolean

j

get j(): T
Shortcut for this.jodit

Returns T

od

get od(): Document
Shortcut for this.ownerDocument

Returns Document

ow

get ow(): Window
Returns Window

ownerDocument

get ownerDocument(): Document
The document in which jodit was created

Returns Document

parentElement

get parentElement(): Nullable<IUIElement>
Returns Nullable<IUIElement>
set parentElement(parentElement): void
Parameters
- parentElement: Nullable<IUIElement>
Returns void

text

get text(): HTMLElement
DOM container for text content

Returns HTMLElement

Methods

afterSetMod

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

appendTo

appendTo(element): ToolbarButton<T>
Append container to element
Parameters
- element: HTMLElement
Returns ToolbarButton<T>

bindDestruct

bindDestruct(component): ToolbarButton<T>
Bind destructor to some View
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns ToolbarButton<T>

bubble

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

className

className(): string
Returns string

closest

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

`Static` closestElement

closestElement(node, type): Nullable<IUIElement>
Find closest UIElement in DOM
Parameters
- node: Node
- type: Function
Returns Nullable<IUIElement>

destruct

destruct(): any
Returns any

focus

focus(): void
Returns void

get

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

getElm

getElm<T>(this, elementName): Nullable<HTMLElement>
Return element with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms<T>(this, elementName): HTMLElement[]
Return elements with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName): string
Calc BEM element class name
Parameters
- elementName: string
  
  element name in the bem classification
Returns string
getFullElName(elementName, mod): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName, mod, modValue): string
Parameters
- elementName: string
- mod: string
- modValue: string | boolean
Returns string

getMod

getMod(this, name): ModType
Get BEM class modification value
Parameters
- this: IMods
- name: string
Returns ModType

hookStatus

hookStatus(status, callback): void
Adds a handler for changing the component's status
Parameters
- status: ComponentStatus
  
  the status at which the callback is triggered
- callback: ((component) => void)
  
  a function that will be called when the status is status
  - - (component): void
    - Parameters
      
      component: ToolbarButton<T>
      
      Returns void
Returns void

i18n

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

isFocused

isFocused(): boolean
Element has focus

Returns boolean

`Static` isInstanceOf

isInstanceOf<T>(c, constructorFunc): c is T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>>
Parameters
- c: unknown
- constructorFunc: Function
Returns c is T

onAction

onAction(callback): ToolbarButton<T>
Add action handler
Parameters
- callback: ((originalEvent) => void)
  - - (originalEvent): void
    - Parameters
      
      originalEvent: MouseEvent
      
      Returns void
Returns ToolbarButton<T>

setMod

setMod<T>(this, name, value, container?): T
Set/remove BEM class modification
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
  
  if null, mod will be removed
- Optional container: HTMLElement
Returns T

setParentView

setParentView(jodit): ToolbarButton<T>
Attach component to View
Parameters
- jodit: IViewBased<IViewOptions>
Returns ToolbarButton<T>

setState

setState(state): ToolbarButton<T>
Set state
Parameters
- state: IUIButtonStatePartial
Returns ToolbarButton<T>

setStatus

setStatus(componentStatus): void
Set component status
Parameters
- componentStatus: ComponentStatus
  
  component status
Returns void

See
ComponentStatus

update

update(): void
Returns void

updateParentElement

updateParentElement(target): ToolbarButton<T>
Parameters
- target: IUIElement
Returns ToolbarButton<T>

Jodit PRO

If you like Jodit - try Jodit PRO

Type Parameters

T extends IViewBased = IViewBased

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IViewBased<IViewOptions> = IViewBased<IViewOptions>

Parameters

jodit: T

control: IControlTypeStrong

target: Nullable<HTMLElement> = null

Returns ToolbarButton<T>

Properties

Static STATUSES

Type declaration

Readonly beforeDestruct: "beforeDestruct"

Readonly beforeInit: "beforeInit"

Readonly destructed: "destructed"

Readonly ready: "ready"

async

container

Readonly control

Readonly isButton

jodit

Readonly mods

name

ownerWindow

Readonly state

Type declaration

activated: boolean

currentValue: string

disabled: boolean

hasTrigger: boolean

icon: IUIIconState

name: string

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

tabIndex: CanUndef<number>

text: string

theme: string

tooltip: string

type: "button" | "submit"

value: string | number | boolean

variant: ButtonVariant

Readonly target

Readonly uid

Accessors

componentName

Returns string

componentStatus

Returns ComponentStatus

Parameters

componentStatus: ComponentStatus

Returns void

defaultTimeout

Returns number

icon

Returns HTMLElement

isDestructed

Returns boolean

isInDestruct

Returns boolean

isReady

Returns boolean

j

Returns T

od

Returns Document

ow

Returns Window

ownerDocument

Returns Document

parentElement

Returns Nullable<IUIElement>

Parameters

`Static` STATUSES

`Readonly` beforeDestruct: "beforeDestruct"

`Readonly` beforeInit: "beforeInit"

`Readonly` destructed: "destructed"

`Readonly` ready: "ready"

`Readonly` control

`Readonly` isButton

`Readonly` mods

`Readonly` state

`Readonly` target

`Readonly` uid

`Static` closestElement

`Optional` obj: IDictionary