Jodit Editor

UIElement

ui.UIElement

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

Type parameters

Name Type
T extends IViewBased = IViewBased

Hierarchy

Implements

constructor

new UIElement<T>(jodit, options?): UIElement<T>

Type parameters

Name Type
T extends IViewBased<IViewOptions> = IViewBased<IViewOptions>

Parameters

Name Type
jodit T
options? IDictionary

Returns

UIElement<T>

Inherited from

ViewComponent.constructor

Defined in

src/core/ui/element.ts#175

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

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

Inherited from

ViewComponent.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Implementation of

IUIElement.async

Inherited from

ViewComponent.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Implementation of

IUIElement.uid

Inherited from

ViewComponent.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation of

IUIElement.ownerWindow

Inherited from

ViewComponent.ownerWindow

Defined in

src/core/component/component.ts#109

jodit

jodit: T

Parent View element

Implementation of

IUIElement.jodit

Inherited from

ViewComponent.jodit

Defined in

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

container

container: HTMLElement

Implementation of

IUIElement.container

Defined in

src/core/ui/element.ts#32

name

name: string = ''

Implementation of

IUIElement.name

Defined in

src/core/ui/element.ts#33

mods

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

Implementation of

Mods.mods

Inherited from

Mods.mods

Defined in

src/core/ui/element.ts#119

componentName

get componentName(): string

Returns

string

Implementation of

IUIElement.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Implementation of

IUIElement.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Implementation of

IUIElement.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Implementation of

IUIElement.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Implementation of

IUIElement.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Implementation of

IUIElement.isDestructed

Defined in

src/core/component/component.ts#152

isInDestruct

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.

Returns

boolean

Implementation of

IUIElement.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Implementation of

IUIElement.componentStatus

Defined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Implementation of

IUIElement.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Implementation of

IUIElement.j

Defined in

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

defaultTimeout

get defaultTimeout(): number

Returns

number

Implementation of

IUIElement.defaultTimeout

Defined in

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

parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Implementation of

IUIElement.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name Type
parentElement Nullable<IUIElement>

Returns

void

Implementation of

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

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

Parameters

Name Type
elementName string
mod string
modValue string | boolean

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#67

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Inherited from

ViewComponent.bindDestruct

Defined in

src/core/component/component.ts#170

className

className(): string

Returns

string

Inherited from

ViewComponent.className

Defined in

src/core/component/component.ts#179

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name Type Description
componentStatus ComponentStatus component status

Returns

void

See

ComponentStatus

Inherited from

ViewComponent.setStatus

Defined in

src/core/component/component.ts#226

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

Inherited from

ViewComponent.hookStatus

Defined in

src/core/component/component.ts#265

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

ViewComponent.isInstanceOf

Defined in

src/core/component/component.ts#283

i18n

i18n(text, ...params): string

Parameters

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

Returns

string

Inherited from

ViewComponent.i18n

Defined in

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

setParentView

setParentView(jodit): this

Attach component to View

Parameters

Name Type
jodit T

Returns

this

Inherited from

ViewComponent.setParentView

Defined in

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

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>

Inherited from

Elms.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[]

Inherited from

Elms.getElms

Defined in

src/core/traits/elms.ts#30

afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Inherited from

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

Inherited from

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

Inherited from

Mods.getMod

Defined in

src/core/traits/mods.ts#64

bubble

bubble(callback): this

Apply callback for all parents

Parameters

Name Type
callback (parent: IUIElement) => void

Returns

this

Defined in

src/core/ui/element.ts#51

updateParentElement

updateParentElement(target): this

Parameters

Name Type
target IUIElement

Returns

this

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>

Inherited from

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

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>

Defined in

src/core/ui/element.ts#106

update

update(): void

Update UI from state

Returns

void

Defined in

src/core/ui/element.ts#124

appendTo

appendTo(element): this

Append container to element

Parameters

Name Type
element HTMLElement

Returns

this

Defined in

src/core/ui/element.ts#131

destruct

destruct(): any

Returns

any

Inherited from

ViewComponent.destruct

Defined in

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

In this article: