UIForm

ui/form.UIForm

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

HierarchyHierarchy

• UIGroup

  ↳ UIForm

ImplementsImplements

• IUIForm

constructorconstructor

new UIForm(...args): UIForm

ParametersParameters

Name	Type
...args	[jodit: IViewBased<IViewOptions>, elements?: (null | false | void | IUIElement)[], options?: IDictionary]

ReturnsReturns

UIForm

OverridesOverrides

UIGroup.constructor

Defined inDefined in

src/core/ui/form/form.ts#90

STATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declaration

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

Inherited fromInherited from

UIGroup.STATUSES

Defined inDefined in

src/core/component/component.ts#40

---

asyncasync

async: IAsync

Implementation ofImplementation of

IUIForm.async

Inherited fromInherited from

UIGroup.async

Defined inDefined in

src/core/component/component.ts#44

---

uiduid

Readonly uid: string

Implementation ofImplementation of

IUIForm.uid

Inherited fromInherited from

UIGroup.uid

Defined inDefined in

src/core/component/component.ts#59

---

ownerWindowownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation ofImplementation of

IUIForm.ownerWindow

Inherited fromInherited from

UIGroup.ownerWindow

Defined inDefined in

src/core/component/component.ts#109

---

joditjodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation ofImplementation of

IUIForm.jodit

Inherited fromInherited from

UIGroup.jodit

Defined inDefined in

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

---

namename

name: string = ''

Implementation ofImplementation of

IUIForm.name

Inherited fromInherited from

UIGroup.name

Defined inDefined in

src/core/ui/element.ts#33

---

modsmods

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

Implementation ofImplementation of

IUIForm.mods

Inherited fromInherited from

UIGroup.mods

Defined inDefined in

src/core/ui/element.ts#119

---

containercontainer

container: HTMLFormElement

Implementation ofImplementation of

IUIForm.container

OverridesOverrides

UIGroup.container

Defined inDefined in

src/core/ui/form/form.ts#28

---

syncModsyncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited fromInherited from

UIGroup.syncMod

Defined inDefined in

src/core/ui/group/group.ts#41

---

elementselements

elements: IUIElement[] = []

Implementation ofImplementation of

IUIForm.elements

Inherited fromInherited from

UIGroup.elements

Defined inDefined in

src/core/ui/group/group.ts#43

---

buttonSizebuttonSize

buttonSize: "small" | "tiny" | "xsmall" | "middle" | "large" = 'middle'

Inherited fromInherited from

UIGroup.buttonSize

Defined inDefined in

src/core/ui/group/group.ts#70

---

optionsoptions

Optional Readonly options: IDictionary

Inherited fromInherited from

UIGroup.options

Defined inDefined in

src/core/ui/group/group.ts#193

componentNamecomponentName

get componentName(): string

ReturnsReturns

string

Implementation ofImplementation of

IUIForm.componentName

Inherited fromInherited from

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

IUIForm.ownerDocument

Inherited fromInherited from

UIGroup.ownerDocument

Defined inDefined in

src/core/component/component.ts#95

---

odod

get od(): Document

Shortcut for this.ownerDocument

ReturnsReturns

Document

Implementation ofImplementation of

IUIForm.od

Inherited fromInherited from

UIGroup.od

Defined inDefined in

src/core/component/component.ts#102

---

owow

get ow(): Window

ReturnsReturns

Window

Implementation ofImplementation of

IUIForm.ow

Inherited fromInherited from

UIGroup.ow

Defined inDefined in

src/core/component/component.ts#110

---

isReadyisReady

get isReady(): boolean

Component is ready for work

ReturnsReturns

boolean

Implementation ofImplementation of

IUIForm.isReady

Inherited fromInherited from

UIGroup.isReady

Defined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturns

boolean

Implementation ofImplementation of

IUIForm.isDestructed

Inherited fromInherited from

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

IUIForm.isInDestruct

Inherited fromInherited from

UIGroup.isInDestruct

Defined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturns

ComponentStatus

Implementation ofImplementation of

IUIForm.componentStatus

Inherited fromInherited from

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

IUIForm.componentStatus

Inherited fromInherited from

UIGroup.componentStatus

Defined inDefined in

src/core/component/component.ts#217

---

jj

get j(): T

Shortcut for this.jodit

ReturnsReturns

T

Implementation ofImplementation of

IUIForm.j

Inherited fromInherited from

UIGroup.j

Defined inDefined in

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

---

defaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturns

number

Implementation ofImplementation of

IUIForm.defaultTimeout

Inherited fromInherited from

UIGroup.defaultTimeout

Defined inDefined in

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

---

parentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation of

IUIForm.parentElement

Inherited fromInherited from

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

IUIForm.parentElement

Inherited fromInherited from

UIGroup.parentElement

Defined inDefined in

src/core/ui/element.ts#41

---

allChildrenallChildren

get allChildren(): IUIElement[]

All group children

ReturnsReturns

IUIElement[]

Implementation ofImplementation of

IUIForm.allChildren

Inherited fromInherited from

UIGroup.allChildren

Defined inDefined in

src/core/ui/group/group.ts#48

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

IUIForm.getFullElName

Inherited fromInherited from

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

IUIForm.getFullElName

Inherited fromInherited from

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

IUIForm.getFullElName

Inherited fromInherited from

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

IUIForm.bindDestruct

Inherited fromInherited from

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

IUIForm.setStatus

Inherited fromInherited from

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

IUIForm.hookStatus

Inherited fromInherited from

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

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

IUIForm.i18n

Inherited fromInherited from

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

IUIForm.setParentView

Inherited fromInherited from

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

IUIForm.getElm

Inherited fromInherited from

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

IUIForm.getElms

Inherited fromInherited from

UIGroup.getElms

Defined inDefined in

src/core/traits/elms.ts#30

---

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

IUIForm.setMod

Inherited fromInherited from

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

IUIForm.getMod

Inherited fromInherited from

UIGroup.getMod

Defined inDefined in

src/core/traits/mods.ts#64

---

bubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.bubble

Inherited fromInherited from

UIGroup.bubble

Defined inDefined in

src/core/ui/element.ts#51

---

updateParentElementupdateParentElement

updateParentElement(target): this

ParametersParameters

Name	Type
target	IUIElement

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.updateParentElement

Inherited fromInherited from

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

IUIForm.get

Inherited fromInherited from

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

IUIForm.closest

Inherited fromInherited from

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

UIGroup.closestElement

Defined inDefined in

src/core/ui/element.ts#106

---

appendToappendTo

appendTo(element): this

Append container to element

ParametersParameters

Name	Type
element	HTMLElement

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.appendTo

Inherited fromInherited from

UIGroup.appendTo

Defined inDefined in

src/core/ui/element.ts#131

---

classNameclassName

className(): string

ReturnsReturns

string

Implementation ofImplementation of

IUIForm.className

OverridesOverrides

UIGroup.className

Defined inDefined in

src/core/ui/form/form.ts#24

---

submitsubmit

submit(): void

ReturnsReturns

void

Implementation ofImplementation of

IUIForm.submit

Defined inDefined in

src/core/ui/form/form.ts#30

---

validatevalidate

validate(): boolean

ReturnsReturns

boolean

Implementation ofImplementation of

IUIForm.validate

Defined inDefined in

src/core/ui/form/form.ts#34

---

onSubmitonSubmit

onSubmit(handler): this

ParametersParameters

Name	Type
handler	(data: IDictionary) => false | void

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.onSubmit

Defined inDefined in

src/core/ui/form/form.ts#58

---

updateupdate

update(): void

Update all children

ReturnsReturns

void

Implementation ofImplementation of

IUIForm.update

Inherited fromInherited from

UIGroup.update

Defined inDefined in

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

---

appendappend

append(elm, index?): this

Append new element into group

ParametersParameters

Name	Type
elm	IUIElement
index?	number

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.append

Inherited fromInherited from

UIGroup.append

Defined inDefined in

src/core/ui/group/group.ts#84

append(elm, distElement?): this

ParametersParameters

Name	Type
elm	IUIElement
distElement?	string

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.append

Inherited fromInherited from

UIGroup.append

Defined inDefined in

src/core/ui/group/group.ts#85

append(elm, distElement?): this

ParametersParameters

Name	Type
elm	IUIElement[]
distElement?	string

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.append

Inherited fromInherited from

UIGroup.append

Defined inDefined in

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

---

afterSetModafterSetMod

afterSetMod(name, value): void

ParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturns

void

Implementation ofImplementation of

IUIForm.afterSetMod

Inherited fromInherited from

UIGroup.afterSetMod

Defined inDefined in

src/core/ui/group/group.ts#134

---

removeremove

remove(elm): this

Remove element from group

ParametersParameters

Name	Type
elm	IUIElement

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.remove

Inherited fromInherited from

UIGroup.remove

Defined inDefined in

src/core/ui/group/group.ts#165

---

clearclear

clear(): this

Clear group

ReturnsReturns

this

Implementation ofImplementation of

IUIForm.clear

Inherited fromInherited from

UIGroup.clear

Defined inDefined in

src/core/ui/group/group.ts#180

---

destructdestruct

destruct(): any

ReturnsReturns

any

Implementation ofImplementation of

IUIForm.destruct

Inherited fromInherited from

UIGroup.destruct

Defined inDefined in

jodit/src/core/ui/group/group.ts:204