Interface IKomoInternal<T>

Type parameters

T: IModel

Hierarchy

{}
- IKomoInternal

Index

Properties

Methods

Properties

register

register: IRegister<T>

Registers an element/field with Komo.

Optional useField

useField: IUseFieldHook<T>

Built in hook for exposing helpers to a given form field.

param: the name of the field/element to bind to.

Optional useFields

useFields: IUseFieldsHook<T>

Built in hook for exposing helpers to a given set of fields.

param: the names of fields/elements you wish to create hooks for.

Methods

handleReset

handleReset(event: BaseSyntheticEvent): Promise<void>
handleReset(values: T): (event: BaseSyntheticEvent) => Promise<void>

- Defined in types.ts:1338
Handles reset for the bound from.

Parameters
- event: BaseSyntheticEvent
  
  the html form event on reset.
Returns Promise<void>
- Defined in types.ts:1345
Handles reset for the bound from with suppiled new values.

Parameters
- values: T
Returns (event: BaseSyntheticEvent) => Promise<void>
- - (event: BaseSyntheticEvent): Promise<void>
  - Parameters
    - event: BaseSyntheticEvent
      
      the html form event on reset.
    Returns Promise<void>

handleSubmit

handleSubmit(handler: SubmitHandler<T>): (event: FormEvent<HTMLFormElement>) => Promise<void>

- Defined in types.ts:1352
Handles form submission.

Parameters
- handler: SubmitHandler<T>
  
  the form submission handler used to submit the form.
Returns (event: FormEvent<HTMLFormElement>) => Promise<void>
- - (event: FormEvent<HTMLFormElement>): Promise<void>
  - Parameters
    - event: FormEvent<HTMLFormElement>
    Returns Promise<void>

init

init(defaults: Partial<T> | Promise<Partial<T>>, isReinit?: boolean, validate?: boolean): void
init(isReinit: boolean, validate?: boolean): void
init(): void

- Defined in types.ts:1375
Initialize Komo, sync defaults and init the schema.

Parameters
- defaults: Partial<T> | Promise<Partial<T>>
  
  the defaults to initialize with.
- Optional isReinit: boolean
  
  whether or not we are reinitizlizing.
- Optional validate: boolean
  
  when true validate on init.
Returns void
- Defined in types.ts:1383
Initialize Komo, sync defaults and init the schema.

Parameters
- isReinit: boolean
  
  whether or not we are reinitizlizing.
- Optional validate: boolean
  
  when true validate on init.
Returns void
- Defined in types.ts:1388
Initialize Komo, sync defaults and init the schema.

Returns void

reinit

reinit(defaults?: Partial<T>): void

- Defined in types.ts:1395
Reinitializes Komo synchronizing default values.

Parameters
- Optional defaults: Partial<T>
  
  default values to reinitialize with.
Returns void

reset

reset(values?: T): void

- Defined in types.ts:1331
Resets form clearing errors and restoring defaults. This is called by "handleReset".

Parameters
- Optional values: T
  
  optional values to reset the form with.
Returns void

update

update(model: Partial<T>, validate?: boolean): void

- Defined in types.ts:1403
Updates model values, resynchronizes and optionally validates the model.

Parameters
- model: Partial<T>
  
  the model to update data with.
- Optional validate: boolean
  
  validates the model after update.
Returns void

Generated using TypeDoc