UIForm

ui/form.UIForm

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

Hierarchy

Implements

constructor

new UIForm(...args): UIForm

Parameters

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

Returns

UIForm

Overrides

UIGroup.constructor

Defined in

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

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

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

Inherited from

UIGroup.STATUSES

Defined in

src/core/component/component.ts#41


async

async: IAsync

Implementation of

IUIForm.async

Inherited from

UIGroup.async

Defined in

src/core/component/component.ts#45


uid

Readonly uid: string

Implementation of

IUIForm.uid

Inherited from

UIGroup.uid

Defined in

src/core/component/component.ts#60


ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation of

IUIForm.ownerWindow

Inherited from

UIGroup.ownerWindow

Defined in

src/core/component/component.ts#110


jodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation of

IUIForm.jodit

Inherited from

UIGroup.jodit

Defined in

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


name

name: string = ''

Implementation of

IUIForm.name

Inherited from

UIGroup.name

Defined in

src/core/ui/element.ts#33


mods

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

Implementation of

IUIForm.mods

Inherited from

UIGroup.mods

Defined in

src/core/ui/element.ts#119


container

container: HTMLFormElement

Implementation of

IUIForm.container

Overrides

UIGroup.container

Defined in

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


syncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited from

UIGroup.syncMod

Defined in

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


elements

elements: IUIElement[] = []

Implementation of

IUIForm.elements

Inherited from

UIGroup.elements

Defined in

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


buttonSize

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

Inherited from

UIGroup.buttonSize

Defined in

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


options

Optional Readonly options: IDictionary

Inherited from

UIGroup.options

Defined in

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

componentName

get componentName(): string

Returns

string

Implementation of

IUIForm.componentName

Inherited from

UIGroup.componentName

Defined in

src/core/component/component.ts#47


ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Implementation of

IUIForm.ownerDocument

Inherited from

UIGroup.ownerDocument

Defined in

src/core/component/component.ts#96


od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Implementation of

IUIForm.od

Inherited from

UIGroup.od

Defined in

src/core/component/component.ts#103


ow

get ow(): Window

Returns

Window

Implementation of

IUIForm.ow

Inherited from

UIGroup.ow

Defined in

src/core/component/component.ts#111


isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Implementation of

IUIForm.isReady

Inherited from

UIGroup.isReady

Defined in

src/core/component/component.ts#146


isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Implementation of

IUIForm.isDestructed

Inherited from

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

IUIForm.isInDestruct

Inherited from

UIGroup.isInDestruct

Defined in

src/core/component/component.ts#161


componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Implementation of

IUIForm.componentStatus

Inherited from

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

IUIForm.componentStatus

Inherited from

UIGroup.componentStatus

Defined in

src/core/component/component.ts#218


j

get j(): T

Shortcut for this.jodit

Returns

T

Implementation of

IUIForm.j

Inherited from

UIGroup.j

Defined in

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


defaultTimeout

get defaultTimeout(): number

Returns

number

Implementation of

IUIForm.defaultTimeout

Inherited from

UIGroup.defaultTimeout

Defined in

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


parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Implementation of

IUIForm.parentElement

Inherited from

UIGroup.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name Type
parentElement Nullable<IUIElement>

Returns

void

Implementation of

IUIForm.parentElement

Inherited from

UIGroup.parentElement

Defined in

src/core/ui/element.ts#41


allChildren

get allChildren(): IUIElement[]

All group children

Returns

IUIElement[]

Implementation of

IUIForm.allChildren

Inherited from

UIGroup.allChildren

Defined in

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

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

IUIForm.getFullElName

Inherited from

UIGroup.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Implementation of

IUIForm.getFullElName

Inherited from

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

IUIForm.getFullElName

Inherited from

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

IUIForm.bindDestruct

Inherited from

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

IUIForm.setStatus

Inherited from

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

IUIForm.hookStatus

Inherited from

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

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

IUIForm.i18n

Inherited from

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

IUIForm.setParentView

Inherited from

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

IUIForm.getElm

Inherited from

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

IUIForm.getElms

Inherited from

UIGroup.getElms

Defined in

src/core/traits/elms.ts#30


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

IUIForm.setMod

Inherited from

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

IUIForm.getMod

Inherited from

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

Implementation of

IUIForm.bubble

Inherited from

UIGroup.bubble

Defined in

src/core/ui/element.ts#51


updateParentElement

updateParentElement(target): this

Parameters

Name Type
target IUIElement

Returns

this

Implementation of

IUIForm.updateParentElement

Inherited from

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

IUIForm.get

Inherited from

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

IUIForm.closest

Inherited from

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

UIGroup.closestElement

Defined in

src/core/ui/element.ts#106


appendTo

appendTo(element): this

Append container to element

Parameters

Name Type
element HTMLElement

Returns

this

Implementation of

IUIForm.appendTo

Inherited from

UIGroup.appendTo

Defined in

src/core/ui/element.ts#131


className

className(): string

Returns

string

Implementation of

IUIForm.className

Overrides

UIGroup.className

Defined in

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


submit

submit(): void

Returns

void

Implementation of

IUIForm.submit

Defined in

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


validate

validate(): boolean

Returns

boolean

Implementation of

IUIForm.validate

Defined in

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


onSubmit

onSubmit(handler): void

Parameters

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

Returns

void

Implementation of

IUIForm.onSubmit

Defined in

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


update

update(): void

Update all children

Returns

void

Implementation of

IUIForm.update

Inherited from

UIGroup.update

Defined in

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


append

append(elm, distElement?): this

Append new element into group

Parameters

Name Type
elm IUIElement | IUIElement[]
distElement? string

Returns

this

Implementation of

IUIForm.append

Inherited from

UIGroup.append

Defined in

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


afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Implementation of

IUIForm.afterSetMod

Inherited from

UIGroup.afterSetMod

Defined in

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


remove

remove(elm): this

Remove element from group

Parameters

Name Type
elm IUIElement

Returns

this

Implementation of

IUIForm.remove

Inherited from

UIGroup.remove

Defined in

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


clear

clear(): this

Clear group

Returns

this

Implementation of

IUIForm.clear

Inherited from

UIGroup.clear

Defined in

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


destruct

destruct(): any

Returns

any

Implementation of

IUIForm.destruct

Inherited from

UIGroup.destruct

Defined in

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