Interface: FormProps<T>

Defined in: types/index.ts:60

Props for the Form component.

Type Parameters

T

T extends object

The type of the form data object

Properties

initialValues

initialValues: T

Defined in: types/index.ts:62

Initial values for the form fields

---

validationSchema?

optional validationSchema: ObjectSchema<T, AnyObject, any, "">

Defined in: types/index.ts:64

Optional Yup validation schema for form validation

---

onSubmit()?

optional onSubmit: (value) => void | Promise<void>

Defined in: types/index.ts:66

Callback function called when the form is successfully submitted

Parameters

value

T

Returns

void | Promise<void>

---

ref?

optional ref: RefObject<null | FormState<T>>

Defined in: types/index.ts:68

Optional ref to access the FormState instance directly

---

historyItems?

optional historyItems: number

Defined in: types/index.ts:70

Number of history items to keep for undo/redo functionality (0 to disable)

---

historyItemThrottle?

optional historyItemThrottle: number

Defined in: types/index.ts:72

Throttle for saving history items (every Nth change)

---

filterHistoryKeys?

optional filterHistoryKeys: string[]

Defined in: types/index.ts:74

Array of field paths to exclude from history tracking

---

onChange()?

optional onChange: (value) => void

Defined in: types/index.ts:76

Callback function called whenever form values change

Parameters

value

T

Returns

void