IUIButton

types.IUIButton

HierarchyHierarchyHierarchy

• IViewComponent

• IUIElement

• IFocusable

  ↳ IUIButton

  ↳↳ IToolbarButton

Implemented byImplemented byImplemented by

• UIButton

modsmodsmods

mods: IDictionary<ModType>

Inherited fromInherited fromInherited from

IUIElement.mods

Defined inDefined inDefined in

src/types/traits.d.ts#28

---

asyncasyncasync

Readonly async: IAsync

Inherited fromInherited fromInherited from

IUIElement.async

Defined inDefined inDefined in

src/types/types.d.ts#46

---

ownerDocumentownerDocumentownerDocument

Readonly ownerDocument: Document

Inherited fromInherited fromInherited from

IUIElement.ownerDocument

Defined inDefined inDefined in

src/types/types.d.ts#47

---

ododod

Readonly od: Document

Inherited fromInherited fromInherited from

IUIElement.od

Defined inDefined inDefined in

src/types/types.d.ts#48

---

ownerWindowownerWindowownerWindow

Readonly ownerWindow: Window

Inherited fromInherited fromInherited from

IUIElement.ownerWindow

Defined inDefined inDefined in

src/types/types.d.ts#49

---

owowow

Readonly ow: Window

Inherited fromInherited fromInherited from

IUIElement.ow

Defined inDefined inDefined in

src/types/types.d.ts#50

---

componentNamecomponentNamecomponentName

Readonly componentName: string

Inherited fromInherited fromInherited from

IUIElement.componentName

Defined inDefined inDefined in

src/types/types.d.ts#54

---

uiduiduid

Readonly uid: string

Inherited fromInherited fromInherited from

IUIElement.uid

Defined inDefined inDefined in

src/types/types.d.ts#65

---

isDestructedisDestructedisDestructed

Readonly isDestructed: boolean

Inherited fromInherited fromInherited from

IUIElement.isDestructed

Defined inDefined inDefined in

src/types/types.d.ts#66

---

isInDestructisInDestructisInDestruct

Readonly isInDestruct: boolean

Inherited fromInherited fromInherited from

IUIElement.isInDestruct

Defined inDefined inDefined in

src/types/types.d.ts#67

---

isReadyisReadyisReady

Readonly isReady: boolean

Inherited fromInherited fromInherited from

IUIElement.isReady

Defined inDefined inDefined in

src/types/types.d.ts#68

---

componentStatuscomponentStatuscomponentStatus

Readonly componentStatus: ComponentStatus

Inherited fromInherited fromInherited from

IUIElement.componentStatus

Defined inDefined inDefined in

src/types/types.d.ts#70

---

joditjoditjodit

jodit: IViewBased<IViewOptions>

Inherited fromInherited fromInherited from

IUIElement.jodit

Defined inDefined inDefined in

src/types/types.d.ts#82

---

jjj

Readonly j: IViewBased<IViewOptions>

Inherited fromInherited fromInherited from

IUIElement.j

Defined inDefined inDefined in

src/types/types.d.ts#83

---

i18ni18ni18n

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

Type declarationType declarationType declaration

(text, ...params): string

ParametersParametersParameters

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

ReturnsReturnsReturns

string

Inherited fromInherited fromInherited from

IUIElement.i18n

Defined inDefined inDefined in

src/types/types.d.ts#85

---

defaultTimeoutdefaultTimeoutdefaultTimeout

Readonly defaultTimeout: number

Inherited fromInherited fromInherited from

IUIElement.defaultTimeout

Defined inDefined inDefined in

src/types/types.d.ts#86

---

parentElementparentElementparentElement

parentElement: Nullable<IUIElement>

Inherited fromInherited fromInherited from

IUIElement.parentElement

Defined inDefined inDefined in

src/types/ui.d.ts#30

---

containercontainercontainer

container: HTMLElement

Inherited fromInherited fromInherited from

IUIElement.container

Defined inDefined inDefined in

src/types/ui.d.ts#31

---

namenamename

name: string

Inherited fromInherited fromInherited from

IUIElement.name

Defined inDefined inDefined in

src/types/ui.d.ts#32

---

statestatestate

Readonly state: IUIButtonState

Defined inDefined inDefined in

src/types/ui.d.ts#87

---

texttexttext

Readonly text: HTMLElement

Defined inDefined inDefined in

src/types/ui.d.ts#91

---

iconiconicon

Readonly icon: HTMLElement

Defined inDefined inDefined in

src/types/ui.d.ts#92

---

isButtonisButtonisButton

Readonly isButton: true

Defined inDefined inDefined in

src/types/ui.d.ts#94

isFocusedisFocusedisFocused

isFocused(): boolean

ReturnsReturnsReturns

boolean

Inherited fromInherited fromInherited from

IFocusable.isFocused

Defined inDefined inDefined in

src/types/form.d.ts#12

---

focusfocusfocus

focus(): void

ReturnsReturnsReturns

void

Inherited fromInherited fromInherited from

IFocusable.focus

Defined inDefined inDefined in

src/types/form.d.ts#13

---

setModsetModsetMod

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

Set/remove modification (null - remove)

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
this	T
name	string
value	ModType

ReturnsReturnsReturns

T

Inherited fromInherited fromInherited from

IUIElement.setMod

Defined inDefined inDefined in

src/types/traits.d.ts#20

---

afterSetModafterSetModafterSetMod

afterSetMod(name, value): void

ParametersParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturnsReturns

void

Inherited fromInherited fromInherited from

IUIElement.afterSetMod

Defined inDefined inDefined in

src/types/traits.d.ts#25

---

getModgetModgetMod

getMod(name): ModType

ParametersParametersParameters

Name	Type
name	string

ReturnsReturnsReturns

ModType

Inherited fromInherited fromInherited from

IUIElement.getMod

Defined inDefined inDefined in

src/types/traits.d.ts#27

---

getElmgetElmgetElm

getElm(elementName): Nullable<HTMLElement>

ParametersParametersParameters

Name	Type
elementName	string

ReturnsReturnsReturns

Nullable<HTMLElement>

Inherited fromInherited fromInherited from

IUIElement.getElm

Defined inDefined inDefined in

src/types/traits.d.ts#32

---

getElmsgetElmsgetElms

getElms(elementName): HTMLElement[]

ParametersParametersParameters

Name	Type
elementName	string

ReturnsReturnsReturns

HTMLElement[]

Inherited fromInherited fromInherited from

IUIElement.getElms

Defined inDefined inDefined in

src/types/traits.d.ts#33

---

destructdestructdestruct

destruct(jodit?): any

ParametersParametersParameters

Name	Type
jodit?	IViewBased<IViewOptions>

ReturnsReturnsReturns

any

Inherited fromInherited fromInherited from

IUIElement.destruct

Defined inDefined inDefined in

src/types/types.d.ts#32

---

getgetget

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

Type parametersType parametersType parameters

Name
T

ParametersParametersParameters

Name	Type
chain	string
obj?	IDictionary<any, string>

ReturnsReturnsReturns

Nullable<T>

Inherited fromInherited fromInherited from

IUIElement.get

Defined inDefined inDefined in

src/types/types.d.ts#52

---

classNameclassNameclassName

className(): string

ReturnsReturnsReturns

string

Inherited fromInherited fromInherited from

IUIElement.className

Defined inDefined inDefined in

src/types/types.d.ts#55

---

getFullElNamegetFullElNamegetFullElName

getFullElName(elementName): string

ParametersParametersParameters

Name	Type
elementName	string

ReturnsReturnsReturns

string

Inherited fromInherited fromInherited from

IUIElement.getFullElName

Defined inDefined inDefined in

src/types/types.d.ts#57

getFullElName(elementName, mod): string

ParametersParametersParameters

Name	Type
elementName	string
mod	string

ReturnsReturnsReturns

string

Inherited fromInherited fromInherited from

IUIElement.getFullElName

Defined inDefined inDefined in

src/types/types.d.ts#58

getFullElName(elementName, mod?, modValue?): string

ParametersParametersParameters

Name	Type
elementName	string
mod?	string
modValue?	string | boolean

ReturnsReturnsReturns

string

Inherited fromInherited fromInherited from

IUIElement.getFullElName

Defined inDefined inDefined in

src/types/types.d.ts#59

---

setStatussetStatussetStatus

setStatus(componentStatus): void

ParametersParametersParameters

Name	Type
componentStatus	ComponentStatus

ReturnsReturnsReturns

void

Inherited fromInherited fromInherited from

IUIElement.setStatus

Defined inDefined inDefined in

src/types/types.d.ts#71

---

hookStatushookStatushookStatus

hookStatus(status, callback): void

ParametersParametersParameters

Name	Type
status	ComponentStatus
callback	(component: this) => void

ReturnsReturnsReturns

void

Inherited fromInherited fromInherited from

IUIElement.hookStatus

Defined inDefined inDefined in

src/types/types.d.ts#73

---

bindDestructbindDestructbindDestruct

bindDestruct(component): this

ParametersParametersParameters

Name	Type
component	IComponent<IViewBased<IViewOptions>>

ReturnsReturnsReturns

this

Inherited fromInherited fromInherited from

IUIElement.bindDestruct

Defined inDefined inDefined in

src/types/types.d.ts#78

---

setParentViewsetParentViewsetParentView

setParentView(jodit): this

ParametersParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturnsReturns

this

Inherited fromInherited fromInherited from

IUIElement.setParentView

Defined inDefined inDefined in

src/types/types.d.ts#84

---

bubblebubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturnsReturns

this

Inherited fromInherited fromInherited from

IUIElement.bubble

Defined inDefined inDefined in

src/types/ui.d.ts#37

---

closestclosestclosest

closest<T>(type): Nullable<T>

Type parametersType parametersType parameters

Name	Type
T	extends IUIElement

ParametersParametersParameters

Name	Type
type	Function

ReturnsReturnsReturns

Nullable<T>

Inherited fromInherited fromInherited from

IUIElement.closest

Defined inDefined inDefined in

src/types/ui.d.ts#39

closest<T>(type): Nullable<T>

Type parametersType parametersType parameters

Name	Type
T	extends IUIElement

ParametersParametersParameters

Name	Type
type	Function | T

ReturnsReturnsReturns

Nullable<T>

Inherited fromInherited fromInherited from

IUIElement.closest

Defined inDefined inDefined in

src/types/ui.d.ts#40

---

updateupdateupdate

update(): void

ReturnsReturnsReturns

void

Inherited fromInherited fromInherited from

IUIElement.update

Defined inDefined inDefined in

src/types/ui.d.ts#42

---

updateParentElementupdateParentElementupdateParentElement

updateParentElement(target): this

ParametersParametersParameters

Name	Type
target	IUIElement

ReturnsReturnsReturns

this

Inherited fromInherited fromInherited from

IUIElement.updateParentElement

Defined inDefined inDefined in

src/types/ui.d.ts#43

---

appendToappendToappendTo

appendTo(element): this

ParametersParametersParameters

Name	Type
element	HTMLElement

ReturnsReturnsReturns

this

Inherited fromInherited fromInherited from

IUIElement.appendTo

Defined inDefined inDefined in

src/types/ui.d.ts#44

---

setStatesetStatesetState

setState(state): this

ParametersParametersParameters

Name	Type
state	IUIButtonStatePartial

ReturnsReturnsReturns

this

Defined inDefined inDefined in

src/types/ui.d.ts#89

---

onActiononActiononAction

onAction(callback): this

ParametersParametersParameters

Name	Type
callback	(event: MouseEvent) => void

ReturnsReturnsReturns

this

Defined inDefined inDefined in

jodit/src/types/ui.d.ts:96