UIButton

ui/button.UIButton

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

HierarchyHierarchyHierarchy

• UIElement

  ↳ UIButton

  ↳↳ ToolbarButton

  ↳↳ ToolbarContent

ImplementsImplementsImplements

• IUIButton

constructorconstructorconstructor

new UIButton(jodit, state?): UIButton

ParametersParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>
state?	IUIButtonStatePartial

ReturnsReturnsReturns

UIButton

OverridesOverridesOverrides

UIElement.constructor

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#233

STATUSESSTATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declarationType declaration

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

Inherited fromInherited fromInherited from

UIElement.STATUSES

Defined inDefined inDefined in

src/core/component/component.ts#40

---

asyncasyncasync

async: IAsync

Implementation ofImplementation ofImplementation of

IUIButton.async

Inherited fromInherited fromInherited from

UIElement.async

Defined inDefined inDefined in

src/core/component/component.ts#44

---

uiduiduid

Readonly uid: string

Implementation ofImplementation ofImplementation of

IUIButton.uid

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.ownerWindow

Inherited fromInherited fromInherited from

UIElement.ownerWindow

Defined inDefined inDefined in

src/core/component/component.ts#109

---

joditjoditjodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation ofImplementation ofImplementation of

IUIButton.jodit

Inherited fromInherited fromInherited from

UIElement.jodit

Defined inDefined inDefined in

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

---

isButtonisButtonisButton

Readonly isButton: true

Marker for buttons

Implementation ofImplementation ofImplementation of

IUIButton.isButton

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#61

---

statestatestate

Readonly state: IUIButtonState

Implementation ofImplementation ofImplementation of

IUIButton.state

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#63

---

containercontainercontainer

container: HTMLElement

Implementation ofImplementation ofImplementation of

IUIButton.container

Inherited fromInherited fromInherited from

UIElement.container

Defined inDefined inDefined in

src/core/ui/element.ts#32

---

namenamename

name: string = ''

Implementation ofImplementation ofImplementation of

IUIButton.name

Inherited fromInherited fromInherited from

UIElement.name

Defined inDefined inDefined in

src/core/ui/element.ts#33

---

modsmodsmods

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

Implementation ofImplementation ofImplementation of

IUIButton.mods

Inherited fromInherited fromInherited from

UIElement.mods

Defined inDefined inDefined in

src/core/ui/element.ts#119

componentNamecomponentNamecomponentName

get componentName(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIButton.componentName

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.ownerDocument

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.od

Inherited fromInherited fromInherited from

UIElement.od

Defined inDefined inDefined in

src/core/component/component.ts#102

---

owowow

get ow(): Window

ReturnsReturnsReturns

Window

Implementation ofImplementation ofImplementation of

IUIButton.ow

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.isReady

Inherited fromInherited fromInherited from

UIElement.isReady

Defined inDefined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIButton.isDestructed

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.isInDestruct

Inherited fromInherited fromInherited from

UIElement.isInDestruct

Defined inDefined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturnsReturns

ComponentStatus

Implementation ofImplementation ofImplementation of

IUIButton.componentStatus

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.componentStatus

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.j

Inherited fromInherited fromInherited from

UIElement.j

Defined inDefined inDefined in

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

---

defaultTimeoutdefaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IUIButton.defaultTimeout

Inherited fromInherited fromInherited from

UIElement.defaultTimeout

Defined inDefined inDefined in

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

---

texttexttext

get text(): HTMLElement

DOM container for text content

ReturnsReturnsReturns

HTMLElement

Implementation ofImplementation ofImplementation of

IUIButton.text

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#77

---

iconiconicon

get icon(): HTMLElement

DOM container for icon

ReturnsReturnsReturns

HTMLElement

Implementation ofImplementation ofImplementation of

IUIButton.icon

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#87

---

parentElementparentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation ofImplementation of

IUIButton.parentElement

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.parentElement

Inherited fromInherited fromInherited from

UIElement.parentElement

Defined inDefined inDefined in

src/core/ui/element.ts#41

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

IUIButton.getFullElName

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.getFullElName

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.getFullElName

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.bindDestruct

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.setStatus

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.hookStatus

Inherited fromInherited fromInherited from

UIElement.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

UIElement.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

IUIButton.i18n

Inherited fromInherited fromInherited from

UIElement.i18n

Defined inDefined inDefined in

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

---

setParentViewsetParentViewsetParentView

setParentView(jodit): this

Attach component to View

ParametersParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIButton.setParentView

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.getElm

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.getElms

Inherited fromInherited fromInherited from

UIElement.getElms

Defined inDefined inDefined in

src/core/traits/elms.ts#30

---

afterSetModafterSetModafterSetMod

afterSetMod(name, value): void

ParametersParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIButton.afterSetMod

Inherited fromInherited fromInherited from

UIElement.afterSetMod

Defined inDefined inDefined in

src/core/traits/mods.ts#23

---

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

IUIButton.setMod

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.getMod

Inherited fromInherited fromInherited from

UIElement.getMod

Defined inDefined inDefined in

src/core/traits/mods.ts#64

---

classNameclassNameclassName

className(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIButton.className

OverridesOverridesOverrides

UIElement.className

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#54

---

setStatesetStatesetState

setState(state): this

Set state

ParametersParametersParameters

Name	Type
state	IUIButtonStatePartial

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIButton.setState

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#68

---

focusfocusfocus

focus(): void

Set focus on an element

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIButton.focus

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#197

---

isFocusedisFocusedisFocused

isFocused(): boolean

Element has focus

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIButton.isFocused

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#204

---

destructdestructdestruct

destruct(): any

ReturnsReturnsReturns

any

Implementation ofImplementation ofImplementation of

IUIButton.destruct

OverridesOverridesOverrides

UIElement.destruct

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#249

---

onActiononActiononAction

onAction(callback): this

Add action handler

ParametersParametersParameters

Name	Type
callback	(originalEvent: MouseEvent) => void

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIButton.onAction

Defined inDefined inDefined in

src/core/ui/button/button/button.ts#259

---

bubblebubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIButton.bubble

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.updateParentElement

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.get

Inherited fromInherited fromInherited from

UIElement.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

IUIButton.closest

Inherited fromInherited fromInherited from

UIElement.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

UIElement.closestElement

Defined inDefined inDefined in

src/core/ui/element.ts#106

---

updateupdateupdate

update(): void

Update UI from state

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIButton.update

Inherited fromInherited fromInherited from

UIElement.update

Defined inDefined inDefined in

src/core/ui/element.ts#124

---

appendToappendToappendTo

appendTo(element): this

Append container to element

ParametersParametersParameters

Name	Type
element	HTMLElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIButton.appendTo

Inherited fromInherited fromInherited from

UIElement.appendTo

Defined inDefined inDefined in

jodit/src/core/ui/element.ts:131