UIButton

ui/button.UIButton

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

Hierarchy

Implements

constructor

new UIButton(jodit, state?): UIButton

Parameters

Name Type
jodit IViewBased<IViewOptions>
state? IUIButtonStatePartial

Returns

UIButton

Overrides

UIElement.constructor

Defined in

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

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

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

Inherited from

UIElement.STATUSES

Defined in

src/core/component/component.ts#41


async

async: IAsync

Implementation of

IUIButton.async

Inherited from

UIElement.async

Defined in

src/core/component/component.ts#45


uid

Readonly uid: string

Implementation of

IUIButton.uid

Inherited from

UIElement.uid

Defined in

src/core/component/component.ts#60


ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation of

IUIButton.ownerWindow

Inherited from

UIElement.ownerWindow

Defined in

src/core/component/component.ts#110


jodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation of

IUIButton.jodit

Inherited from

UIElement.jodit

Defined in

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


isButton

Readonly isButton: true

Marker for buttons

Implementation of

IUIButton.isButton

Defined in

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


state

Readonly state: IUIButtonState

Implementation of

IUIButton.state

Defined in

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


container

container: HTMLElement

Implementation of

IUIButton.container

Inherited from

UIElement.container

Defined in

src/core/ui/element.ts#32


name

name: string = ''

Implementation of

IUIButton.name

Inherited from

UIElement.name

Defined in

src/core/ui/element.ts#33


mods

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

Implementation of

IUIButton.mods

Inherited from

UIElement.mods

Defined in

src/core/ui/element.ts#119

componentName

get componentName(): string

Returns

string

Implementation of

IUIButton.componentName

Inherited from

UIElement.componentName

Defined in

src/core/component/component.ts#47


ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Implementation of

IUIButton.ownerDocument

Inherited from

UIElement.ownerDocument

Defined in

src/core/component/component.ts#96


od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Implementation of

IUIButton.od

Inherited from

UIElement.od

Defined in

src/core/component/component.ts#103


ow

get ow(): Window

Returns

Window

Implementation of

IUIButton.ow

Inherited from

UIElement.ow

Defined in

src/core/component/component.ts#111


isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Implementation of

IUIButton.isReady

Inherited from

UIElement.isReady

Defined in

src/core/component/component.ts#146


isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Implementation of

IUIButton.isDestructed

Inherited from

UIElement.isDestructed

Defined in

src/core/component/component.ts#153


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

Implementation of

IUIButton.isInDestruct

Inherited from

UIElement.isInDestruct

Defined in

src/core/component/component.ts#161


componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Implementation of

IUIButton.componentStatus

Inherited from

UIElement.componentStatus

Defined in

src/core/component/component.ts#211

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Implementation of

IUIButton.componentStatus

Inherited from

UIElement.componentStatus

Defined in

src/core/component/component.ts#218


j

get j(): T

Shortcut for this.jodit

Returns

T

Implementation of

IUIButton.j

Inherited from

UIElement.j

Defined in

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


defaultTimeout

get defaultTimeout(): number

Returns

number

Implementation of

IUIButton.defaultTimeout

Inherited from

UIElement.defaultTimeout

Defined in

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


text

get text(): HTMLElement

DOM container for text content

Returns

HTMLElement

Implementation of

IUIButton.text

Defined in

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


icon

get icon(): HTMLElement

DOM container for icon

Returns

HTMLElement

Implementation of

IUIButton.icon

Defined in

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


parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Implementation of

IUIButton.parentElement

Inherited from

UIElement.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name Type
parentElement Nullable<IUIElement>

Returns

void

Implementation of

IUIButton.parentElement

Inherited from

UIElement.parentElement

Defined in

src/core/ui/element.ts#41

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name Type Description
elementName string element name in the bem classification

Returns

string

Implementation of

IUIButton.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Implementation of

IUIButton.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#67

getFullElName(elementName, mod, modValue): string

Parameters

Name Type
elementName string
mod string
modValue string | boolean

Returns

string

Implementation of

IUIButton.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#68


bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Implementation of

IUIButton.bindDestruct

Inherited from

UIElement.bindDestruct

Defined in

src/core/component/component.ts#171


setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name Type Description
componentStatus ComponentStatus component status

Returns

void

See

ComponentStatus

Implementation of

IUIButton.setStatus

Inherited from

UIElement.setStatus

Defined in

src/core/component/component.ts#227


hookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

Parameters

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

Returns

void

Implementation of

IUIButton.hookStatus

Inherited from

UIElement.hookStatus

Defined in

src/core/component/component.ts#266


isInstanceOf

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

Type parameters

Name Type
T extends Component

Parameters

Name Type
c unknown
constructorFunc Function

Returns

c is T

Inherited from

UIElement.isInstanceOf

Defined in

src/core/component/component.ts#284


i18n

i18n(text, ...params): string

Parameters

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

Returns

string

Implementation of

IUIButton.i18n

Inherited from

UIElement.i18n

Defined in

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


setParentView

setParentView(jodit): this

Attach component to View

Parameters

Name Type
jodit IViewBased<IViewOptions>

Returns

this

Implementation of

IUIButton.setParentView

Inherited from

UIElement.setParentView

Defined in

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


getElm

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

Return element with BEM class name

Type parameters

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

Parameters

Name Type
this T
elementName string

Returns

Nullable<HTMLElement>

Implementation of

IUIButton.getElm

Inherited from

UIElement.getElm

Defined in

src/core/traits/elms.ts#18


getElms

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

Return elements with BEM class name

Type parameters

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

Parameters

Name Type
this T
elementName string

Returns

HTMLElement[]

Implementation of

IUIButton.getElms

Inherited from

UIElement.getElms

Defined in

src/core/traits/elms.ts#30


afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Implementation of

IUIButton.afterSetMod

Inherited from

UIElement.afterSetMod

Defined in

src/core/traits/mods.ts#23


setMod

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

Set/remove BEM class modification

Type parameters

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

Parameters

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

Returns

T

Implementation of

IUIButton.setMod

Inherited from

UIElement.setMod

Defined in

src/core/traits/mods.ts#30


getMod

getMod(this, name): ModType

Get BEM class modification value

Parameters

Name Type
this IMods
name string

Returns

ModType

Implementation of

IUIButton.getMod

Inherited from

UIElement.getMod

Defined in

src/core/traits/mods.ts#64


className

className(): string

Returns

string

Implementation of

IUIButton.className

Overrides

UIElement.className

Defined in

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


setState

setState(state): this

Set state

Parameters

Name Type
state IUIButtonStatePartial

Returns

this

Implementation of

IUIButton.setState

Defined in

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


focus

focus(): void

Set focus on element

Returns

void

Implementation of

IUIButton.focus

Defined in

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


isFocused

isFocused(): boolean

Element has focus

Returns

boolean

Implementation of

IUIButton.isFocused

Defined in

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


destruct

destruct(): any

Returns

any

Implementation of

IUIButton.destruct

Overrides

UIElement.destruct

Defined in

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


onAction

onAction(callback): this

Add action handler

Parameters

Name Type
callback (originalEvent: MouseEvent) => void

Returns

this

Implementation of

IUIButton.onAction

Defined in

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


bubble

bubble(callback): this

Apply callback for all parents

Parameters

Name Type
callback (parent: IUIElement) => void

Returns

this

Implementation of

IUIButton.bubble

Inherited from

UIElement.bubble

Defined in

src/core/ui/element.ts#51


updateParentElement

updateParentElement(target): this

Parameters

Name Type
target IUIElement

Returns

this

Implementation of

IUIButton.updateParentElement

Inherited from

UIElement.updateParentElement

Defined in

src/core/ui/element.ts#62


get

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

Type parameters

Name
T

Parameters

Name Type
chain string
obj? IDictionary

Returns

Nullable<T>

Implementation of

IUIButton.get

Inherited from

UIElement.get

Defined in

src/core/ui/element.ts#68


closest

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

Find match parent

Type parameters

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

Parameters

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

Returns

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

Implementation of

IUIButton.closest

Inherited from

UIElement.closest

Defined in

src/core/ui/element.ts#75


closestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

Parameters

Name Type
node Node
type Function

Returns

Nullable<IUIElement>

Inherited from

UIElement.closestElement

Defined in

src/core/ui/element.ts#106


update

update(): void

Update UI from state

Returns

void

Implementation of

IUIButton.update

Inherited from

UIElement.update

Defined in

src/core/ui/element.ts#124


appendTo

appendTo(element): this

Append container to element

Parameters

Name Type
element HTMLElement

Returns

this

Implementation of

IUIButton.appendTo

Inherited from

UIElement.appendTo

Defined in

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