IUIForm | Jodit Editor

Hierarchy

IUIGroup
- IUIForm

Implemented by

UIForm

Methods

afterSetMod

afterSetMod(name: string, value: ModType): void
Parameters
- name: string
- value: ModType
Returns void

append

append(elm: IUIElement | IUIElement[], distElement?: string): IUIForm
Parameters
- elm: IUIElement | IUIElement[]
- Optional distElement: string
Returns IUIForm

appendTo

appendTo(element: HTMLElement): IUIForm
Parameters
- element: HTMLElement
Returns IUIForm

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): IUIForm
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns IUIForm

bubble

bubble(callback: ((parent: IUIElement) => void)): IUIForm
Apply callback for all parents
Parameters
- callback: ((parent: IUIElement) => void)
  - - (parent: IUIElement): void
    - Parameters
      
      parent: IUIElement
      
      Returns void
Returns IUIForm

className

className(): string
Returns string

clear

clear(): IUIForm
Returns IUIForm

closest

closest<T>(type: Function): Nullable<T>
Type Parameters
- T extends IUIElement<T>
Parameters
- type: Function
Returns Nullable<T>
closest<T>(type: Function | T): Nullable<T>
Type Parameters
- T extends IUIElement<T>
Parameters
- type: Function | T
Returns Nullable<T>

destruct

destruct(jodit?: IViewBased<IViewOptions>): any
Parameters
- Optional jodit: IViewBased<IViewOptions>
Returns any

get

get<T>(chain: string, obj?: IDictionary<any, string>): Nullable<T>
Type Parameters
- T
Parameters
- chain: string
- Optional obj: IDictionary<any, string>
Returns Nullable<T>

getElm

getElm(elementName: string): Nullable<HTMLElement>
Parameters
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms(elementName: string): HTMLElement[]
Parameters
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Parameters
- elementName: string
Returns string
getFullElName(elementName: string, mod: string): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName: string, mod?: string, modValue?: string | boolean): string
Parameters
- elementName: string
- Optional mod: string
- Optional modValue: string | boolean
Returns string

getMod

getMod(name: string): ModType
Parameters
- name: string
Returns ModType

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: IUIForm) => void)): void
Parameters
- status: ComponentStatus
- callback: ((component: IUIForm) => void)
  - - (component: IUIForm): void
    - Parameters
      
      component: IUIForm
      
      Returns void
Returns void

onSubmit

onSubmit(handler: ((data: IDictionary<any, string>) => false | void)): void
Parameters
- handler: ((data: IDictionary<any, string>) => false | void)
  - - (data: IDictionary<any, string>): false | void
    - Parameters
      
      data: IDictionary<any, string>
      
      Returns false | void
Returns void

remove

remove(elm: IUIElement): IUIForm
Parameters
- elm: IUIElement
Returns IUIForm

setMod

setMod<T>(this: T, name: string, value: ModType): T
Set/remove modification (null - remove)
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
Returns T

setParentView

setParentView(jodit: IViewBased<IViewOptions>): IUIForm
Parameters
- jodit: IViewBased<IViewOptions>
Returns IUIForm

setStatus

setStatus(componentStatus: ComponentStatus): void
Parameters
- componentStatus: ComponentStatus
Returns void

submit

submit(): void
Returns void

update

update(): void
Returns void

updateParentElement

updateParentElement(target: IUIElement): IUIForm
Parameters
- target: IUIElement
Returns IUIForm

validate

validate(): boolean
Returns boolean

Properties

allChildren

allChildren: IUIElement[]

`Readonly` async

async: IAsync

`Readonly` componentName

componentName: string

`Readonly` componentStatus

componentStatus: ComponentStatus

container

container: HTMLFormElement

`Readonly` defaultTimeout

defaultTimeout: number

elements

elements: IUIElement[]

`Readonly` i18n

i18n: ((text: string, ...params: (string | number)[]) => string)

Type declaration

- (text: string, ...params: (string | number)[]): string
- Parameters
  - text: string
  - Rest ...params: (string | number)[]
  Returns string

`Readonly` isDestructed

isDestructed: boolean

`Readonly` isInDestruct

isInDestruct: boolean

`Readonly` isReady

isReady: boolean

name

name: string

`Readonly` od

od: Document

`Readonly` ow

ow: Window

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` ownerWindow

ownerWindow: Window

parentElement

parentElement: Nullable<IUIElement>

`Readonly` uid

uid: string

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implemented by

Index

Methods

Properties

Methods

afterSetMod

Parameters

name: string

value: ModType

Returns void

append

Parameters

elm: IUIElement | IUIElement[]

Optional distElement: string

Returns IUIForm

appendTo

Parameters

element: HTMLElement

Returns IUIForm

bindDestruct

Parameters

component: IComponent<IViewBased<IViewOptions>>

Returns IUIForm

bubble

Parameters

callback: ((parent: IUIElement) => void)

Parameters

parent: IUIElement

Returns void

Returns IUIForm

className

Returns string

clear

Returns IUIForm

closest

Type Parameters

T extends IUIElement<T>

Parameters

type: Function

Returns Nullable<T>

Type Parameters

T extends IUIElement<T>

Parameters

type: Function | T

Returns Nullable<T>

destruct

Parameters

Optional jodit: IViewBased<IViewOptions>

Returns any

get

Type Parameters

T

Parameters

chain: string

Optional obj: IDictionary<any, string>

Returns Nullable<T>

getElm

Parameters

elementName: string

Returns Nullable<HTMLElement>

getElms

Parameters

elementName: string

Returns HTMLElement[]

getFullElName

Parameters

elementName: string

Returns string

Parameters

elementName: string

mod: string

Returns string

Parameters

elementName: string

Optional mod: string

Optional modValue: string | boolean

Returns string

getMod

Parameters

`Optional` distElement: string

`Optional` jodit: IViewBased<IViewOptions>

`Optional` obj: IDictionary<any, string>

`Optional` mod: string

`Optional` modValue: string | boolean

`Readonly` async

`Readonly` componentName

`Readonly` componentStatus

`Readonly` defaultTimeout

`Readonly` i18n

`Rest` ...params: (string | number)[]

`Readonly` isDestructed

`Readonly` isInDestruct

`Readonly` isReady

`Readonly` j

`Readonly` od

`Readonly` ow