FieldComponentProps
FieldComponentProps =
object
Defined in: packages/forms/src/types.ts:109
Props passed to field components by the auto-generated form.
Both built-in plugin components and custom components provided via FieldConfig.component receive these props.
Properties
Section titled “Properties”enumValues?
Section titled “enumValues?”
optionalenumValues:string[]
Defined in: packages/forms/src/types.ts:121
Available options for select/enum fields.
error?
Section titled “error?”
optionalerror:string
Defined in: packages/forms/src/types.ts:119
Validation error message, if any.
label:
string
Defined in: packages/forms/src/types.ts:113
Human-readable label for the field.
name:
string
Defined in: packages/forms/src/types.ts:111
The field name, used as the form registration key.
placeholder?
Section titled “placeholder?”
optionalplaceholder:string
Defined in: packages/forms/src/types.ts:115
Optional placeholder text for the input.
register
Section titled “register”register:
UseFormRegister<FieldValues>
Defined in: packages/forms/src/types.ts:123
The react-hook-form register function for binding the input to form state.
required
Section titled “required”required:
boolean
Defined in: packages/forms/src/types.ts:117
Whether the field is required (NOT NULL in the schema).