UIForm

ui/form.UIForm

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

HierarchyHierarchyHierarchy

• UIGroup

  ↳ UIForm

ImplementsImplementsImplements

• IUIForm

constructorconstructorconstructor

new UIForm(...args): UIForm

ParametersParametersParameters

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

ReturnsReturnsReturns

UIForm

OverridesOverridesOverrides

UIGroup.constructor

Defined inDefined inDefined in

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

STATUSESSTATUSESSTATUSES

Static STATUSES: Object = STATUSES

Type declarationType declarationType declaration

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

Inherited fromInherited fromInherited from

UIGroup.STATUSES

Defined inDefined inDefined in

src/core/component/component.ts#40

---

asyncasyncasync

async: IAsync

Implementation ofImplementation ofImplementation of

IUIForm.async

Inherited fromInherited fromInherited from

UIGroup.async

Defined inDefined inDefined in

src/core/component/component.ts#44

---

uiduiduid

Readonly uid: string

Implementation ofImplementation ofImplementation of

IUIForm.uid

Inherited fromInherited fromInherited from

UIGroup.uid

Defined inDefined inDefined in

src/core/component/component.ts#59

---

ownerWindowownerWindowownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation ofImplementation ofImplementation of

IUIForm.ownerWindow

Inherited fromInherited fromInherited from

UIGroup.ownerWindow

Defined inDefined inDefined in

src/core/component/component.ts#109

---

joditjoditjodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation ofImplementation ofImplementation of

IUIForm.jodit

Inherited fromInherited fromInherited from

UIGroup.jodit

Defined inDefined inDefined in

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

---

namenamename

name: string = ''

Implementation ofImplementation ofImplementation of

IUIForm.name

Inherited fromInherited fromInherited from

UIGroup.name

Defined inDefined inDefined in

src/core/ui/element.ts#33

---

modsmodsmods

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

Implementation ofImplementation ofImplementation of

IUIForm.mods

Inherited fromInherited fromInherited from

UIGroup.mods

Defined inDefined inDefined in

src/core/ui/element.ts#119

---

containercontainercontainer

container: HTMLFormElement

Implementation ofImplementation ofImplementation of

IUIForm.container

OverridesOverridesOverrides

UIGroup.container

Defined inDefined inDefined in

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

---

syncModsyncModsyncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited fromInherited fromInherited from

UIGroup.syncMod

Defined inDefined inDefined in

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

---

elementselementselements

elements: IUIElement[] = []

Implementation ofImplementation ofImplementation of

IUIForm.elements

Inherited fromInherited fromInherited from

UIGroup.elements

Defined inDefined inDefined in

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

---

buttonSizebuttonSizebuttonSize

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

Inherited fromInherited fromInherited from

UIGroup.buttonSize

Defined inDefined inDefined in

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

---

optionsoptionsoptions

Optional Readonly options: IDictionary

Inherited fromInherited fromInherited from

UIGroup.options

Defined inDefined inDefined in

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

componentNamecomponentNamecomponentName

get componentName(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.componentName

Inherited fromInherited fromInherited from

UIGroup.componentName

Defined inDefined inDefined in

src/core/component/component.ts#46

---

ownerDocumentownerDocumentownerDocument

get ownerDocument(): Document

The document in which jodit was created

ReturnsReturnsReturns

Document

Implementation ofImplementation ofImplementation of

IUIForm.ownerDocument

Inherited fromInherited fromInherited from

UIGroup.ownerDocument

Defined inDefined inDefined in

src/core/component/component.ts#95

---

ododod

get od(): Document

Shortcut for this.ownerDocument

ReturnsReturnsReturns

Document

Implementation ofImplementation ofImplementation of

IUIForm.od

Inherited fromInherited fromInherited from

UIGroup.od

Defined inDefined inDefined in

src/core/component/component.ts#102

---

owowow

get ow(): Window

ReturnsReturnsReturns

Window

Implementation ofImplementation ofImplementation of

IUIForm.ow

Inherited fromInherited fromInherited from

UIGroup.ow

Defined inDefined inDefined in

src/core/component/component.ts#110

---

isReadyisReadyisReady

get isReady(): boolean

Component is ready for work

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIForm.isReady

Inherited fromInherited fromInherited from

UIGroup.isReady

Defined inDefined inDefined in

src/core/component/component.ts#145

---

isDestructedisDestructedisDestructed

get isDestructed(): boolean

Component was destructed

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIForm.isDestructed

Inherited fromInherited fromInherited from

UIGroup.isDestructed

Defined inDefined inDefined in

src/core/component/component.ts#152

---

isInDestructisInDestructisInDestruct

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.

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIForm.isInDestruct

Inherited fromInherited fromInherited from

UIGroup.isInDestruct

Defined inDefined inDefined in

src/core/component/component.ts#160

---

componentStatuscomponentStatuscomponentStatus

get componentStatus(): ComponentStatus

Current component status

ReturnsReturnsReturns

ComponentStatus

Implementation ofImplementation ofImplementation of

IUIForm.componentStatus

Inherited fromInherited fromInherited from

UIGroup.componentStatus

Defined inDefined inDefined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

ParametersParametersParameters

Name	Type
componentStatus	ComponentStatus

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.componentStatus

Inherited fromInherited fromInherited from

UIGroup.componentStatus

Defined inDefined inDefined in

src/core/component/component.ts#217

---

jjj

get j(): T

Shortcut for this.jodit

ReturnsReturnsReturns

T

Implementation ofImplementation ofImplementation of

IUIForm.j

Inherited fromInherited fromInherited from

UIGroup.j

Defined inDefined inDefined in

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

---

defaultTimeoutdefaultTimeoutdefaultTimeout

get defaultTimeout(): number

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IUIForm.defaultTimeout

Inherited fromInherited fromInherited from

UIGroup.defaultTimeout

Defined inDefined inDefined in

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

---

parentElementparentElementparentElement

get parentElement(): Nullable<IUIElement>

ReturnsReturnsReturns

Nullable<IUIElement>

Implementation ofImplementation ofImplementation of

IUIForm.parentElement

Inherited fromInherited fromInherited from

UIGroup.parentElement

Defined inDefined inDefined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

ParametersParametersParameters

Name	Type
parentElement	Nullable<IUIElement>

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.parentElement

Inherited fromInherited fromInherited from

UIGroup.parentElement

Defined inDefined inDefined in

src/core/ui/element.ts#41

---

allChildrenallChildrenallChildren

get allChildren(): IUIElement[]

All group children

ReturnsReturnsReturns

IUIElement[]

Implementation ofImplementation ofImplementation of

IUIForm.allChildren

Inherited fromInherited fromInherited from

UIGroup.allChildren

Defined inDefined inDefined in

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

getFullElNamegetFullElNamegetFullElName

getFullElName(elementName): string

Calc BEM element class name

ParametersParametersParameters

Name	Type	Description
elementName	string	element name in the bem classification

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.getFullElName

Inherited fromInherited fromInherited from

UIGroup.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

ParametersParametersParameters

Name	Type
elementName	string
mod	string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.getFullElName

Inherited fromInherited fromInherited from

UIGroup.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

ParametersParametersParameters

Name	Type
elementName	string
mod	string
modValue	string | boolean

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.getFullElName

Inherited fromInherited fromInherited from

UIGroup.getFullElName

Defined inDefined inDefined in

src/core/component/component.ts#67

---

bindDestructbindDestructbindDestruct

bindDestruct(component): this

Bind destructor to some View

ParametersParametersParameters

Name	Type
component	IComponent<IViewBased<IViewOptions>>

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.bindDestruct

Inherited fromInherited fromInherited from

UIGroup.bindDestruct

Defined inDefined inDefined in

src/core/component/component.ts#170

---

setStatussetStatussetStatus

setStatus(componentStatus): void

Set component status

ParametersParametersParameters

Name	Type	Description
componentStatus	ComponentStatus	component status

ReturnsReturnsReturns

void

See

ComponentStatus

Implementation ofImplementation ofImplementation of

IUIForm.setStatus

Inherited fromInherited fromInherited from

UIGroup.setStatus

Defined inDefined inDefined in

src/core/component/component.ts#226

---

hookStatushookStatushookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

ParametersParametersParameters

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

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.hookStatus

Inherited fromInherited fromInherited from

UIGroup.hookStatus

Defined inDefined inDefined in

src/core/component/component.ts#265

---

isInstanceOfisInstanceOfisInstanceOf

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

Type parametersType parametersType parameters

Name	Type
T	extends Component

ParametersParametersParameters

Name	Type
c	unknown
constructorFunc	Function

ReturnsReturnsReturns

c is T

Inherited fromInherited fromInherited from

UIGroup.isInstanceOf

Defined inDefined inDefined in

src/core/component/component.ts#283

---

i18ni18ni18n

i18n(text, ...params): string

ParametersParametersParameters

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

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.i18n

Inherited fromInherited fromInherited from

UIGroup.i18n

Defined inDefined inDefined in

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

---

setParentViewsetParentViewsetParentView

setParentView(jodit): this

Attach component to View

ParametersParametersParameters

Name	Type
jodit	IViewBased<IViewOptions>

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.setParentView

Inherited fromInherited fromInherited from

UIGroup.setParentView

Defined inDefined inDefined in

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

---

getElmgetElmgetElm

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

Return element with BEM class name

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturnsReturns

Nullable<HTMLElement>

Implementation ofImplementation ofImplementation of

IUIForm.getElm

Inherited fromInherited fromInherited from

UIGroup.getElm

Defined inDefined inDefined in

src/core/traits/elms.ts#18

---

getElmsgetElmsgetElms

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

Return elements with BEM class name

Type parametersType parametersType parameters

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

ParametersParametersParameters

Name	Type
this	T
elementName	string

ReturnsReturnsReturns

HTMLElement[]

Implementation ofImplementation ofImplementation of

IUIForm.getElms

Inherited fromInherited fromInherited from

UIGroup.getElms

Defined inDefined inDefined in

src/core/traits/elms.ts#30

---

setModsetModsetMod

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

Set/remove BEM class modification

Type parametersType parametersType parameters

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

ParametersParametersParameters

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

ReturnsReturnsReturns

T

Implementation ofImplementation ofImplementation of

IUIForm.setMod

Inherited fromInherited fromInherited from

UIGroup.setMod

Defined inDefined inDefined in

src/core/traits/mods.ts#30

---

getModgetModgetMod

getMod(this, name): ModType

Get BEM class modification value

ParametersParametersParameters

Name	Type
this	IMods
name	string

ReturnsReturnsReturns

ModType

Implementation ofImplementation ofImplementation of

IUIForm.getMod

Inherited fromInherited fromInherited from

UIGroup.getMod

Defined inDefined inDefined in

src/core/traits/mods.ts#64

---

bubblebubblebubble

bubble(callback): this

Apply callback for all parents

ParametersParametersParameters

Name	Type
callback	(parent: IUIElement) => void

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.bubble

Inherited fromInherited fromInherited from

UIGroup.bubble

Defined inDefined inDefined in

src/core/ui/element.ts#51

---

updateParentElementupdateParentElementupdateParentElement

updateParentElement(target): this

ParametersParametersParameters

Name	Type
target	IUIElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.updateParentElement

Inherited fromInherited fromInherited from

UIGroup.updateParentElement

Defined inDefined inDefined in

src/core/ui/element.ts#62

---

getgetget

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

Type parametersType parametersType parameters

Name
T

ParametersParametersParameters

Name	Type
chain	string
obj?	IDictionary

ReturnsReturnsReturns

Nullable<T>

Implementation ofImplementation ofImplementation of

IUIForm.get

Inherited fromInherited fromInherited from

UIGroup.get

Defined inDefined inDefined in

src/core/ui/element.ts#68

---

closestclosestclosest

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

Find match parent

Type parametersType parametersType parameters

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

ParametersParametersParameters

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

ReturnsReturnsReturns

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

Implementation ofImplementation ofImplementation of

IUIForm.closest

Inherited fromInherited fromInherited from

UIGroup.closest

Defined inDefined inDefined in

src/core/ui/element.ts#75

---

closestElementclosestElementclosestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

ParametersParametersParameters

Name	Type
node	Node
type	Function

ReturnsReturnsReturns

Nullable<IUIElement>

Inherited fromInherited fromInherited from

UIGroup.closestElement

Defined inDefined inDefined in

src/core/ui/element.ts#106

---

appendToappendToappendTo

appendTo(element): this

Append container to element

ParametersParametersParameters

Name	Type
element	HTMLElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.appendTo

Inherited fromInherited fromInherited from

UIGroup.appendTo

Defined inDefined inDefined in

src/core/ui/element.ts#131

---

classNameclassNameclassName

className(): string

ReturnsReturnsReturns

string

Implementation ofImplementation ofImplementation of

IUIForm.className

OverridesOverridesOverrides

UIGroup.className

Defined inDefined inDefined in

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

---

submitsubmitsubmit

submit(): void

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.submit

Defined inDefined inDefined in

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

---

validatevalidatevalidate

validate(): boolean

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

IUIForm.validate

Defined inDefined inDefined in

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

---

onSubmitonSubmitonSubmit

onSubmit(handler): this

ParametersParametersParameters

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

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.onSubmit

Defined inDefined inDefined in

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

---

updateupdateupdate

update(): void

Update all children

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.update

Inherited fromInherited fromInherited from

UIGroup.update

Defined inDefined inDefined in

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

---

appendappendappend

append(elm, distElement?): this

Append new element into group

ParametersParametersParameters

Name	Type
elm	IUIElement | IUIElement[]
distElement?	string

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.append

Inherited fromInherited fromInherited from

UIGroup.append

Defined inDefined inDefined in

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

---

afterSetModafterSetModafterSetMod

afterSetMod(name, value): void

ParametersParametersParameters

Name	Type
name	string
value	ModType

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IUIForm.afterSetMod

Inherited fromInherited fromInherited from

UIGroup.afterSetMod

Defined inDefined inDefined in

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

---

removeremoveremove

remove(elm): this

Remove element from group

ParametersParametersParameters

Name	Type
elm	IUIElement

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.remove

Inherited fromInherited fromInherited from

UIGroup.remove

Defined inDefined inDefined in

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

---

clearclearclear

clear(): this

Clear group

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

IUIForm.clear

Inherited fromInherited fromInherited from

UIGroup.clear

Defined inDefined inDefined in

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

---

destructdestructdestruct

destruct(): any

ReturnsReturnsReturns

any

Implementation ofImplementation ofImplementation of

IUIForm.destruct

Inherited fromInherited fromInherited from

UIGroup.destruct

Defined inDefined inDefined in

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