ArrayField
Defined in: packages/core/src/fields/array/types.ts:103
Resolved configuration for an array() field, after all defaults are applied.
This is the type that framework adapters and field components receive —
fieldDef in InputComponentProps<ArrayField<ArrayType>> and
CellComponentProps<ArrayField<ArrayType>> is this type.
- ArrayFieldInput for the user-facing input type
- array for the config function that produces this type
Extends
Section titled “Extends”BaseField<TFieldMeta>
Type Parameters
Section titled “Type Parameters”TArrayType
Section titled “TArrayType”TArrayType extends ArrayType = string
TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends BaseFieldMeta = BaseFieldMeta
Properties
Section titled “Properties”admin:
FieldAdminConfig
Defined in: packages/core/src/fields/array/types.ts:117
Resolved admin UI configuration with all defaults applied.
Overrides
Section titled “Overrides”defaultValue
Section titled “defaultValue”defaultValue:
TArrayType[]
Defined in: packages/core/src/fields/array/types.ts:119
Pre-filled value shown in the admin form when creating a new field.
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:252
Semantic description of the field. Used in three places:
- Helper text rendered below the field input in the admin form UI.
- As the Zod
.meta({ description })value for form validation. - As the JSDoc comment on the generated document interface property.
To write a separate JSDoc comment, use interfaceDescription in addition.
Inherited from
Section titled “Inherited from”index?
Section titled “index?”
optionalindex?:string
Defined in: packages/core/src/fields/baseTypes.ts:256
Convex index name for this field.
Inherited from
Section titled “Inherited from”interfaceDescription?
Section titled “interfaceDescription?”
optionalinterfaceDescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:254
The JSDoc comment on the generated document interface property
Inherited from
Section titled “Inherited from”BaseField.interfaceDescription
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/baseTypes.ts:258
TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").
Inherited from
Section titled “Inherited from”items:
AdminField
Defined in: packages/core/src/fields/array/types.ts:120
label:
string
Defined in: packages/core/src/fields/array/types.ts:109
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Overrides
Section titled “Overrides”labels
Section titled “labels”labels:
object
Defined in: packages/core/src/fields/array/types.ts:110
plural
Section titled “plural”plural:
string
singular
Section titled “singular”singular:
string
optionalmax?:object
Defined in: packages/core/src/fields/array/types.ts:129
Maximum allowed array length config.
error?
Section titled “error?”
optionalerror?:string
Maximum allowed array length error message.
value:
number
Maximum allowed array length.
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”
optionalmin?:object
Defined in: packages/core/src/fields/array/types.ts:122
Minimum allowed array length config.
error?
Section titled “error?”
optionalerror?:string
Minimum allowed array length error message.
value:
number
Minimum allowed array length.
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/array/types.ts:115
Whether this field is required in the database schema.
Overrides
Section titled “Overrides”
readonlytype:"array"
Defined in: packages/core/src/fields/array/types.ts:107