Class ReactForm<T>

Type Parameters

T extends MobxZodTypes

Hierarchy

MobxZodForm<T>
- ReactForm

Constructors

constructor

new ReactForm<T>(schema, _options?): ReactForm<T>
Type Parameters
- T extends MobxZodTypes
Parameters
- schema: T
- Optional _options: MobxZodFormOptions<T>
Returns ReactForm<T>
Inherited from MobxZodForm<T>.constructor
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:52

Properties

`Optional` _boundSubmitForm

_boundSubmitForm?: ((e) => Promise<void>)

Type declaration

- (e): Promise<void>
- Parameters
  - e: FormEvent<HTMLFormElement>
  Returns Promise<void>

_curFieldUniqueId

_curFieldUniqueId: number

`Optional` _currentSetActionOptions

_currentSetActionOptions?: SetActionOptions

_isDirty

_isDirty: boolean

_isSubmitting

_isSubmitting: boolean

_isValidationPending

_isValidationPending: boolean

`Readonly` _options

_options: MobxZodFormOptions<T>

`Optional` _parsed

_parsed?: SafeParseReturnType<T["_input"], T["_output"]>

_rawInput

_rawInput: unknown

_submitCount

_submitCount: number

`Optional` _submitFuture

_submitFuture?: PromiseWithResolvers<void>

_validationTasks

_validationTasks: ValidationTask[]

element

element: null | HTMLFormElement

id

id: string

root

root: MapZodTypeToField<T>

`Readonly` schema

schema: T

schemaFormMeta

schemaFormMeta: FormMeta

Accessors

input

get input(): SafeDecodeResult<unknown, T["_input"]>
Returns SafeDecodeResult<unknown, T["_input"]>
Inherited from MobxZodForm.input
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:71

isDirty

get isDirty(): boolean
Returns boolean
Inherited from MobxZodForm.isDirty
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:67

isSubmitting

get isSubmitting(): boolean
Returns boolean
Inherited from MobxZodForm.isSubmitting
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:70

isValidationPending

get isValidationPending(): boolean
Returns boolean
Inherited from MobxZodForm.isValidationPending
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:68

looseInput

get looseInput(): SafeDecodeResult<unknown, unknown>
Returns SafeDecodeResult<unknown, unknown>
Inherited from MobxZodForm.looseInput
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:72

options

get options(): {
    initialOutput: any;
    plugins: MobxZodPlugin[];
    setActionOptions: {
        validateSync: boolean;
    };
    shouldFocusError: false | "first-y" | "first-x";
    validateOnMount: boolean;
}
Returns {
    initialOutput: any;
    plugins: MobxZodPlugin[];
    setActionOptions: {
        validateSync: boolean;
    };
    shouldFocusError: false | "first-y" | "first-x";
    validateOnMount: boolean;
}
- initialOutput: any
- plugins: MobxZodPlugin[]
- setActionOptions: {
  validateSync: boolean;
  }
  - validateSync: boolean
- shouldFocusError: false | "first-y" | "first-x"
- validateOnMount: boolean
Inherited from MobxZodForm.options
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:57

parsed

get parsed(): SafeParseReturnType<T["_input"], T["_output"]>
Returns SafeParseReturnType<T["_input"], T["_output"]>
Inherited from MobxZodForm.parsed
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:73

rawInput

get rawInput(): unknown
Returns unknown
Inherited from MobxZodForm.rawInput
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:66

submitCount

get submitCount(): number
Returns number
Inherited from MobxZodForm.submitCount
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:69

Methods

_getRawInputAt

_getRawInputAt(path): unknown
Parameters
- path: ParsePath
Returns unknown
Inherited from MobxZodForm._getRawInputAt
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:74

_notifyChange

_notifyChange(): void
Returns void
Inherited from MobxZodForm._notifyChange
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:76

_setRawInputAt

_setRawInputAt(path, value): void
Parameters
- path: ParsePath
- value: unknown
Returns void
Inherited from MobxZodForm._setRawInputAt
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:75

bindField

bindField<T>(field, options?): DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>
Type Parameters
- T extends ZodTypeAny
Parameters
- field: MobxZodField<T>
- options: BindInputOptions = ...
Returns DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>
- Defined in mobx-zod-form-react/src/ReactForm.ts:161

bindForm

bindForm(options?): DetailedHTMLProps<FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>
Parameters
- options: BindFormOptions<T> = {}
Returns DetailedHTMLProps<FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>
- Defined in mobx-zod-form-react/src/ReactForm.ts:81

bindLabel

bindLabel<T>(field, options?): DetailedHTMLProps<LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>
Type Parameters
- T extends ZodTypeAny
Parameters
- field: MobxZodField<T>
- options: BindInputOptions = ...
Returns DetailedHTMLProps<LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>
- Defined in mobx-zod-form-react/src/ReactForm.ts:151

bindTextArea

bindTextArea<T>(field): {
    id: string;
    name: string;
    onBlur: (() => void);
    onChange: ((e) => void);
    value: any;
    ref(element): void;
}
Type Parameters
- T extends ZodTypeAny
Parameters
- field: MobxZodField<T>
Returns {
    id: string;
    name: string;
    onBlur: (() => void);
    onChange: ((e) => void);
    value: any;
    ref(element): void;
}
- id: string
- name: string
- onBlur: (() => void)
  - - (): void
    - Returns void
- onChange: ((e) => void)
  - - (e): void
    - Parameters
      e: ChangeEvent<HTMLTextAreaElement>
      Returns void
- value: any
- ref:function
  - ref(element): void
  - Parameters
    - element: null | HTMLTextAreaElement
    Returns void
    - Defined in mobx-zod-form-react/src/ReactForm.ts:258
- Defined in mobx-zod-form-react/src/ReactForm.ts:253

flushValidationTasks

flushValidationTasks(): void
Returns void
Inherited from MobxZodForm.flushValidationTasks
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:54

focusError

focusError(): void
Returns void
Inherited from MobxZodForm.focusError
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:88

getFieldUniqueId

getFieldUniqueId(): string
Returns string
Inherited from MobxZodForm.getFieldUniqueId
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:53

handleSubmit

handleSubmit(onSubmit): Promise<void>
Parameters
- onSubmit: (() => void | Promise<void>)
  - - (): void | Promise<void>
    - Returns void | Promise<void>
Returns Promise<void>
Inherited from MobxZodForm.handleSubmit
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:87

resolveCurrentSetActionOptions

resolveCurrentSetActionOptions(): SetActionOptions
Returns SetActionOptions
Inherited from MobxZodForm.resolveCurrentSetActionOptions
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:86

start

start(): (() => void)
Returns (() => void)
- - (): void
  - Returns void
Inherited from MobxZodForm.start
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:56

startValidationWorker

startValidationWorker(): (() => void)
Returns (() => void)
- - (): void
  - Returns void
Inherited from MobxZodForm.startValidationWorker
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:55

submitForm

submitForm(): Promise<void>
Programatically submit the form.
1. Triggers a submit event on the form.
2. Await the submission handler to resolve or reject.
Returns Promise<void>
- Defined in mobx-zod-form-react/src/ReactForm.ts:119

validate

validate(): void
Parse the input with the root schema, then compare the new issues with old issues. Only assign new errors to corresponding fields, so that those unrelated fields are untouched. Errors are compared against their error messages.

Returns void
Inherited from MobxZodForm.validate
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:84

withSetActionOptions

withSetActionOptions(options, action): void
Parameters
- options: InputSetActionOptions
- action: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from MobxZodForm.withSetActionOptions
- Defined in mobx-zod-form/lib/MobxZodForm.d.ts:85

`Static` getDomId

getDomId<T>(field, options?): string
Type Parameters
- T extends ZodTypeAny
Parameters
- field: MobxZodField<T>
- options: BindInputOptions = ...
Returns string
- Defined in mobx-zod-form-react/src/ReactForm.ts:136

`Static` getDomName

getDomName<T>(field): string
Type Parameters
- T extends ZodTypeAny
Parameters
- field: MobxZodField<T>
Returns string
- Defined in mobx-zod-form-react/src/ReactForm.ts:132

Class ReactForm<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReactForm<T>

Properties

Optional _boundSubmitForm

Type declaration

Parameters

Returns Promise<void>

_curFieldUniqueId

Optional _currentSetActionOptions

_isDirty

_isSubmitting

_isValidationPending

Readonly _options

Optional _parsed

_rawInput

_submitCount

Optional _submitFuture

_validationTasks

element

id

root

Readonly schema

schemaFormMeta

Accessors

input

Returns SafeDecodeResult<unknown, T["_input"]>

isDirty

Returns boolean

isSubmitting

Returns boolean

isValidationPending

Returns boolean

looseInput

Returns SafeDecodeResult<unknown, unknown>

options

Returns { initialOutput: any; plugins: MobxZodPlugin[]; setActionOptions: { validateSync: boolean; }; shouldFocusError: false | "first-y" | "first-x"; validateOnMount: boolean; }

initialOutput: any

plugins: MobxZodPlugin[]

setActionOptions: { validateSync: boolean; }

validateSync: boolean

shouldFocusError: false | "first-y" | "first-x"

validateOnMount: boolean

parsed

Returns SafeParseReturnType<T["_input"], T["_output"]>

rawInput

Returns unknown

submitCount

Returns number

Methods

_getRawInputAt

Parameters

Returns unknown

_notifyChange

Returns void

_setRawInputAt

Parameters

Returns void

bindField

Type Parameters

Parameters

Returns DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>

bindForm

Parameters

Returns DetailedHTMLProps<FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>

bindLabel

Type Parameters

Parameters

Returns DetailedHTMLProps<LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>

bindTextArea

`Optional` _boundSubmitForm

`Optional` _currentSetActionOptions

`Readonly` _options

`Optional` _parsed

`Optional` _submitFuture

`Readonly` schema

Returns {
initialOutput: any;
plugins: MobxZodPlugin[];
setActionOptions: {
validateSync: boolean;
};
shouldFocusError: false | "first-y" | "first-x";
validateOnMount: boolean;
}

setActionOptions: {
validateSync: boolean;
}

Returns {
id: string;
name: string;
onBlur: (() => void);
onChange: ((e) => void);
value: any;
ref(element): void;
}

`Static` getDomId

`Static` getDomName