ChildTableComponentProps
ChildTableComponentProps =
object
Defined in: packages/forms/src/types.ts:362
Props for the FormPluginComponents.childTable component.
Receives the introspected child fields, the live row values, and a set of row-level callbacks. The plugin is responsible for rendering inputs for each row and wiring up the add / remove / reorder buttons.
Properties
Section titled “Properties”canAddRow
Section titled “canAddRow”canAddRow:
boolean
Defined in: packages/forms/src/types.ts:374
Whether the user is allowed to add another row.
canRemoveRow
Section titled “canRemoveRow”canRemoveRow:
boolean
Defined in: packages/forms/src/types.ts:376
Whether the user is allowed to remove a row right now.
error?
Section titled “error?”
optionalerror:string
Defined in: packages/forms/src/types.ts:388
Optional validation error displayed above the rows (e.g. min row violations).
fieldOverrides?
Section titled “fieldOverrides?”
optionalfieldOverrides:Partial<Record<string,FieldConfig>>
Defined in: packages/forms/src/types.ts:370
Per-field overrides for the child rows.
fields
Section titled “fields”fields:
FieldDefinition[]
Defined in: packages/forms/src/types.ts:368
Visible field definitions for each row.
form:
UseFormReturn<FieldValues>
Defined in: packages/forms/src/types.ts:390
The underlying react-hook-form instance for binding row inputs via register.
label:
string
Defined in: packages/forms/src/types.ts:366
Heading rendered above the table (label override or humanised name).
name:
string
Defined in: packages/forms/src/types.ts:364
Stable name (object key) under which the array is stored in form values.
onAddRow()
Section titled “onAddRow()”onAddRow: () =>
void
Defined in: packages/forms/src/types.ts:380
Append a new empty row, applying configured field defaults.
Returns
Section titled “Returns”void
onMoveDown()
Section titled “onMoveDown()”onMoveDown: (
index) =>void
Defined in: packages/forms/src/types.ts:386
Move the row at index one slot down (no-op at the bottom).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
onMoveUp()
Section titled “onMoveUp()”onMoveUp: (
index) =>void
Defined in: packages/forms/src/types.ts:384
Move the row at index one slot up (no-op at the top).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
onRemoveRow()
Section titled “onRemoveRow()”onRemoveRow: (
index) =>void
Defined in: packages/forms/src/types.ts:382
Remove the row at the given index.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
plugin
Section titled “plugin”plugin:
FormPlugin
Defined in: packages/forms/src/types.ts:392
Plugin used to render individual cells.
reorderable
Section titled “reorderable”reorderable:
boolean
Defined in: packages/forms/src/types.ts:378
Whether reorder controls should be rendered.
rowIds
Section titled “rowIds”rowIds:
string[]
Defined in: packages/forms/src/types.ts:372
Stable ids for each row, in render order. Use these as React keys.