UIButton

ui/button.UIButton

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

HierarchyHierarchy

• UIElement

  ↳ UIButton

  ↳↳ ToolbarButton

  ↳↳ ToolbarContent

ImplementsImplements

• IUIButton

constructorconstructor

new UIButton(jodit, state?): UIButton

ParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>
state?	IUIButtonStatePartial

ReturnsReturns

UIButton

OverridesOverrides

UIElement.constructor

Defined inDefined in

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

STATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declaration

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

Inherited fromInherited from

UIElement.STATUSES

Defined inDefined in

src/core/component/component.ts#40

---

asyncasync

async: IAsync

Implementation ofImplementation of

IUIButton.async

Inherited fromInherited from

UIElement.async

Defined inDefined in

src/core/component/component.ts#44

---

uiduid

Readonly uid: string

Implementation ofImplementation of

IUIButton.uid

Inherited fromInherited from

UIElement.uid

Defined inDefined in

src/core/component/component.ts#59

---

ownerWindowownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation ofImplementation of

IUIButton.ownerWindow

Inherited fromInherited from

UIElement.ownerWindow

Defined inDefined in

src/core/component/component.ts#109

---

joditjodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation ofImplementation of

IUIButton.jodit

Inherited fromInherited from

UIElement.jodit

Defined inDefined in

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

---

isButtonisButton

Readonly isButton: true

Marker for buttons

Implementation ofImplementation of

IUIButton.isButton

Defined inDefined in

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

---

statestate

Readonly state: IUIButtonState

Implementation ofImplementation of

IUIButton.state

Defined inDefined in

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

---

containercontainer

container: HTMLElement

Implementation ofImplementation of

IUIButton.container

Inherited fromInherited from

UIElement.container

Defined inDefined in

src/core/ui/element.ts#32

---

namename

name: string = ''

Implementation ofImplementation of

IUIButton.name

Inherited fromInherited from

UIElement.name

Defined inDefined in

src/core/ui/element.ts#33

---

modsmods

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

Implementation ofImplementation of

IUIButton.mods

Inherited fromInherited from

UIElement.mods

Defined inDefined in

src/core/ui/element.ts#119

componentNamecomponentName

get componentName(): string

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.componentName

Inherited fromInherited from

UIElement.componentName

Defined inDefined in

src/core/component/component.ts#46

---

ownerDocumentownerDocument

get ownerDocument(): Document

The document in which jodit was created

ReturnsReturns

Document

Implementation ofImplementation of

IUIButton.ownerDocument

Inherited fromInherited from

UIElement.ownerDocument

Defined inDefined in

src/core/component/component.ts#95

---

odod

get od(): Document

Shortcut for this.ownerDocument

ReturnsReturns

Document

Implementation ofImplementation of

IUIButton.od

Inherited fromInherited from

UIElement.od

Defined inDefined in

src/core/component/component.ts#102

---

owow

get ow(): Window

ReturnsReturns

Window

Implementation ofImplementation of

IUIButton.ow

Inherited fromInherited from

UIElement.ow

Defined inDefined in

src/core/component/component.ts#110

---

isReadyisReady

get isReady(): boolean

Component is ready for work

ReturnsReturns

boolean

Implementation ofImplementation of

IUIButton.isReady

Inherited fromInherited from

UIElement.isReady

Defined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturns

boolean

Implementation ofImplementation of

IUIButton.isDestructed

Inherited fromInherited from

UIElement.isDestructed

Defined inDefined in

src/core/component/component.ts#152

---

isInDestructisInDestruct

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.

ReturnsReturns

boolean

Implementation ofImplementation of

IUIButton.isInDestruct

Inherited fromInherited from

UIElement.isInDestruct

Defined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturns

ComponentStatus

Implementation ofImplementation of

IUIButton.componentStatus

Inherited fromInherited from

UIElement.componentStatus

Defined inDefined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

ParametersParameters

Name	Type
componentStatus	ComponentStatus

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.componentStatus

Inherited fromInherited from

UIElement.componentStatus

Defined inDefined in

src/core/component/component.ts#217

---

jj

get j(): T

Shortcut for this.jodit

ReturnsReturns

T

Implementation ofImplementation of

IUIButton.j

Inherited fromInherited from

UIElement.j

Defined inDefined in

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

---

defaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturns

number

Implementation ofImplementation of

IUIButton.defaultTimeout

Inherited fromInherited from

UIElement.defaultTimeout

Defined inDefined in

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

---

texttext

get text(): HTMLElement

DOM container for text content

ReturnsReturns

HTMLElement

Implementation ofImplementation of

IUIButton.text

Defined inDefined in

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

---

iconicon

get icon(): HTMLElement

DOM container for icon

ReturnsReturns

HTMLElement

Implementation ofImplementation of

IUIButton.icon

Defined inDefined in

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

---

parentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation of

IUIButton.parentElement

Inherited fromInherited from

UIElement.parentElement

Defined inDefined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

ParametersParameters

Name	Type
parentElement	Nullable<IUIElement>

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.parentElement

Inherited fromInherited from

UIElement.parentElement

Defined inDefined in

src/core/ui/element.ts#41

getFullElNamegetFullElName

getFullElName(elementName): string

Calc BEM element class name

ParametersParameters

Name	Type	Description
elementName	string	element name in the bem classification

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.getFullElName

Inherited fromInherited from

UIElement.getFullElName

Defined inDefined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

ParametersParameters

Name	Type
elementName	string
mod	string

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.getFullElName

Inherited fromInherited from

UIElement.getFullElName

Defined inDefined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

ParametersParameters

Name	Type
elementName	string
mod	string
modValue	string | boolean

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.getFullElName

Inherited fromInherited from

UIElement.getFullElName

Defined inDefined in

src/core/component/component.ts#67

---

bindDestructbindDestruct

bindDestruct(component): this

Bind destructor to some View

ParametersParameters

Name	Type
component	IComponent<IViewBased<IViewOptions>>

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.bindDestruct

Inherited fromInherited from

UIElement.bindDestruct

Defined inDefined in

src/core/component/component.ts#170

---

setStatussetStatus

setStatus(componentStatus): void

Set component status

ParametersParameters

Name	Type	Description
componentStatus	ComponentStatus	component status

ReturnsReturns

void

See

ComponentStatus

Implementation ofImplementation of

IUIButton.setStatus

Inherited fromInherited from

UIElement.setStatus

Defined inDefined in

src/core/component/component.ts#226

---

hookStatushookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

ParametersParameters

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

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.hookStatus

Inherited fromInherited from

UIElement.hookStatus

Defined inDefined in

src/core/component/component.ts#265

---

isInstanceOfisInstanceOf

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

Type parametersType parameters

Name	Type
T	extends Component

ParametersParameters

Name	Type
c	unknown
constructorFunc	Function

ReturnsReturns

c is T

Inherited fromInherited from

UIElement.isInstanceOf

Defined inDefined in

src/core/component/component.ts#283

---

i18ni18n

i18n(text, ...params): string

ParametersParameters

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

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.i18n

Inherited fromInherited from

UIElement.i18n

Defined inDefined in

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

---

setParentViewsetParentView

setParentView(jodit): this

Attach component to View

ParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.setParentView

Inherited fromInherited from

UIElement.setParentView

Defined inDefined in

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

---

getElmgetElm

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

Return element with BEM class name

Type parametersType parameters

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

ParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturns

Nullable<HTMLElement>

Implementation ofImplementation of

IUIButton.getElm

Inherited fromInherited from

UIElement.getElm

Defined inDefined in

src/core/traits/elms.ts#18

---

getElmsgetElms

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

Return elements with BEM class name

Type parametersType parameters

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

ParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturns

HTMLElement[]

Implementation ofImplementation of

IUIButton.getElms

Inherited fromInherited from

UIElement.getElms

Defined inDefined in

src/core/traits/elms.ts#30

---

afterSetModafterSetMod

afterSetMod(name, value): void

ParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.afterSetMod

Inherited fromInherited from

UIElement.afterSetMod

Defined inDefined in

src/core/traits/mods.ts#23

---

setModsetMod

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

Set/remove BEM class modification

Type parametersType parameters

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

ParametersParameters

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

ReturnsReturns

T

Implementation ofImplementation of

IUIButton.setMod

Inherited fromInherited from

UIElement.setMod

Defined inDefined in

src/core/traits/mods.ts#30

---

getModgetMod

getMod(this, name): ModType

Get BEM class modification value

ParametersParameters

Name	Type
this	IMods
name	string

ReturnsReturns

ModType

Implementation ofImplementation of

IUIButton.getMod

Inherited fromInherited from

UIElement.getMod

Defined inDefined in

src/core/traits/mods.ts#64

---

classNameclassName

className(): string

ReturnsReturns

string

Implementation ofImplementation of

IUIButton.className

OverridesOverrides

UIElement.className

Defined inDefined in

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

---

setStatesetState

setState(state): this

Set state

ParametersParameters

Name	Type
state	IUIButtonStatePartial

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.setState

Defined inDefined in

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

---

focusfocus

focus(): void

Set focus on an element

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.focus

Defined inDefined in

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

---

isFocusedisFocused

isFocused(): boolean

Element has focus

ReturnsReturns

boolean

Implementation ofImplementation of

IUIButton.isFocused

Defined inDefined in

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

---

destructdestruct

destruct(): any

ReturnsReturns

any

Implementation ofImplementation of

IUIButton.destruct

OverridesOverrides

UIElement.destruct

Defined inDefined in

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

---

onActiononAction

onAction(callback): this

Add action handler

ParametersParameters

Name	Type
callback	(originalEvent: MouseEvent) => void

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.onAction

Defined inDefined in

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

---

bubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.bubble

Inherited fromInherited from

UIElement.bubble

Defined inDefined in

src/core/ui/element.ts#51

---

updateParentElementupdateParentElement

updateParentElement(target): this

ParametersParameters

Name	Type
target	IUIElement

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.updateParentElement

Inherited fromInherited from

UIElement.updateParentElement

Defined inDefined in

src/core/ui/element.ts#62

---

getget

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

Type parametersType parameters

Name
T

ParametersParameters

Name	Type
chain	string
obj?	IDictionary

ReturnsReturns

Nullable<T>

Implementation ofImplementation of

IUIButton.get

Inherited fromInherited from

UIElement.get

Defined inDefined in

src/core/ui/element.ts#68

---

closestclosest

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

Find match parent

Type parametersType parameters

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

ParametersParameters

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

ReturnsReturns

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

Implementation ofImplementation of

IUIButton.closest

Inherited fromInherited from

UIElement.closest

Defined inDefined in

src/core/ui/element.ts#75

---

closestElementclosestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

ParametersParameters

Name	Type
node	Node
type	Function

ReturnsReturns

Nullable<IUIElement>

Inherited fromInherited from

UIElement.closestElement

Defined inDefined in

src/core/ui/element.ts#106

---

updateupdate

update(): void

Update UI from state

ReturnsReturns

void

Implementation ofImplementation of

IUIButton.update

Inherited fromInherited from

UIElement.update

Defined inDefined in

src/core/ui/element.ts#124

---

appendToappendTo

appendTo(element): this

Append container to element

ParametersParameters

Name	Type
element	HTMLElement

ReturnsReturns

this

Implementation ofImplementation of

IUIButton.appendTo

Inherited fromInherited from

UIElement.appendTo

Defined inDefined in

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