FieldConfig

FieldConfig = object

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

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:138

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

computed()?

optional computed: (values) => unknown

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

Compute this field’s value from the rest of the form values. The function is re-evaluated whenever any watched form value changes, and the result is written back into the form via setValue so it shows up in the rendered input and the submitted payload.

Computed fields are typically combined with readOnly: true.

Parameters

values

Record<string, unknown>

Returns

unknown

Example

fields: {
  totalCalories: {
    computed: (values) =>
      values.ingredients.reduce(
        (sum, ing) => sum + (ing.calories * ing.amount) / 100,
        0,
      ),
    readOnly: true,
  },
}