Form | @bytesoftio/form

Type parameters

TValues: object
TResult

Hierarchy

Form

Implements

ObservableForm<TValues, TResult>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Form(initialValues: TValues): Form

- Defined in Form.ts:41
Parameters
- initialValues: TValues
Returns Form

Properties

changedFields

changedFields: ObservableFormFields

config

config: FormConfig<TValues, TResult>

dirtyFields

dirtyFields: ObservableFormFields

errors

errors: ObservableErrors

result

result: ObservableValue<TResult | undefined>

submitted

submitted: ObservableValue<boolean>

submitting

submitting: ObservableValue<boolean>

values

values: ObservableFormValues<TValues>

Methods

configure

configure(config: Partial<FormConfig<TValues, TResult>>): this

Implementation of ObservableForm.configure
- Defined in Form.ts:88
Parameters
- config: Partial<FormConfig<TValues, TResult>>
Returns this

deps

deps(field: string | string[], options?: DepsOptions): any[]

Implementation of ObservableForm.deps
- Defined in Form.ts:208
Parameters
- field: string | string[]
- Default value options: DepsOptions = {}
Returns any[]

handler

handler(handler: FormHandler<TValues, TResult>): this

Implementation of ObservableForm.handler
- Defined in Form.ts:94
Parameters
- handler: FormHandler<TValues, TResult>
Returns this

listen

listen(callback: FormCallback<TValues, TResult>, notifyImmediately?: undefined | false | true): this

Implementation of ObservableForm.listen
- Defined in Form.ts:74
Parameters
- callback: FormCallback<TValues, TResult>
- Optional notifyImmediately: undefined | false | true
Returns this

reset

reset(initialValues?: TValues): void

Implementation of ObservableForm.reset
- Defined in Form.ts:64
Parameters
- Optional initialValues: TValues
Returns void

schema

schema(handler: ObjectSchema<TValues>): this

Implementation of ObservableForm.schema
- Defined in Form.ts:106
Parameters
- handler: ObjectSchema<TValues>
Returns this

Protected setupValidateOnChange

setupValidateOnChange(): void

- Defined in Form.ts:231
Returns void

submit

submit(options?: FormSubmitOptions): Promise<TResult | undefined>

Implementation of ObservableForm.submit
- Defined in Form.ts:112
Parameters
- Optional options: FormSubmitOptions
Returns Promise<TResult | undefined>

validate

validate(options?: FormValidateOptions): Promise<ValidationResult | undefined>

Implementation of ObservableForm.validate
- Defined in Form.ts:153
Parameters
- Optional options: FormValidateOptions
Returns Promise<ValidationResult | undefined>

validator

validator(handler: FormValidator<TValues, TResult>): this

Implementation of ObservableForm.validator
- Defined in Form.ts:100
Parameters
- handler: FormValidator<TValues, TResult>
Returns this