FieldConfig

FieldConfig = object

Defined in: packages/forms/src/types.ts:88

Per-field overrides for customizing auto-generated form fields.

Pass a record of { [columnName]: FieldConfig } to the AutoForm fields prop to override labels, placeholders, visibility, defaults, components, or validation for individual fields.

Example

<AutoForm
  table={posts}
  mode="create"
  fields={{
    title: { label: "Post Title", placeholder: "Enter a title..." },
    content: { component: RichTextEditor },
    authorId: { hidden: true, default: currentUser.id },
  }}
  onSubmit={handleSubmit}
/>

Properties

component?

optional component: React.ComponentType<FieldComponentProps>

Defined in: packages/forms/src/types.ts:98

Custom React component to render instead of the plugin’s default for this input type.

---

default?

optional default: unknown

Defined in: packages/forms/src/types.ts:96

Default value for the field in create mode.

---

hidden?

optional hidden: boolean

Defined in: packages/forms/src/types.ts:94

Hide this field from the rendered form. The field is still submitted if a default is set.

---

label?

optional label: string

Defined in: packages/forms/src/types.ts:90

Override the auto-generated label for this field.

---

placeholder?

optional placeholder: string

Defined in: packages/forms/src/types.ts:92

Placeholder text shown inside the input.

---

validate()?

optional validate: (value) => string | undefined

Defined in: packages/forms/src/types.ts:100

Custom validation function. Return an error message string to fail, or undefined to pass.

Parameters

value

unknown

Returns

string | undefined