ArrayFieldInput

Defined in: packages/core/src/fields/array/types.ts:75

Configuration input for an array() field.

Array fields store ordered lists of values — strings, numbers, booleans, or nested objects. The items property defines the type of each element using any VexCMS field builder (including nested array() for multi-dimensional arrays). All properties are optional; unset properties fall back to the defaults listed below.

Defaults applied by array():

{
  type:            "array",
  label:           "",       // inferred from the field key by defineCollection
  required:        false,    // field is optional by default
  defaultValue:    [],       // empty array shown in admin form
  admin: {
    hidden:        false,   // visible in the admin form
    readOnly:      false,   // editable by default
    position:      "main",  // placed in the main content column, not the sidebar
    width: "100%",  // spans the full form width, not half
    cellAlignment: "left",  // item count aligned left in the data table column
  }
}

Example

// String tags — label inferred from key ("Tags")
tags: array({ items: text() })

// Required number array with max length
scores: array({ required: true, items: number(), max: 10 })

// Nested array — array of arrays of numbers (2D matrix)
matrix: array({ items: array({ items: number() }) })

// Object items — each item is a structured sub-document
links: array({
  items: object({
    label: text(),
    href: url(),
  }),
})

See

BaseFieldInput for shared properties (label, description, required, admin, index, searchIndex)

Extends

• BaseFieldInput<TCollectionSlug, TFieldKey, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldKey

TFieldKey extends string = never

TArrayType

TArrayType extends ArrayType = string

TFieldMeta

TFieldMeta extends object = { }

Properties

admin?

optional admin?: FieldAdminConfigInput<TCollectionSlug, ComponentHKT>

Defined in: packages/core/src/fields/baseTypes.ts:531

Admin UI configuration for this field.

Inherited from

BaseFieldInput.admin

---

defaultValue?

optional defaultValue?: TArrayType[]

Defined in: packages/core/src/fields/array/types.ts:86

Pre-filled value shown in the admin form when creating a new field. Does not apply to database values

Overrides

BaseFieldInput.defaultValue

---

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:516

Semantic description of the field. Used in three places:

1. Helper text rendered below the field input in the admin form UI.
2. As the Zod .meta({ description }) value for form validation.
3. As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

Inherited from

BaseFieldInput.description

---

index?

optional index?: FieldIndexConfigInput<TCollectionSlug, TFieldKey>

Defined in: packages/core/src/fields/baseTypes.ts:545

Create a database index on this field. The string value becomes the index name in Convex.

Example

slug: { type: "text", index: "by_slug", required: true }
// Generates: .index("by_slug", ["slug"])

author: { type: "relationship", index: { name: "by_author_status", additionalFields: ["status"] } }
// Generates: .index("by_author_status", ["author", "status"])

Inherited from

BaseFieldInput.index

---

interfaceDescription?

optional interfaceDescription?: string

Defined in: packages/core/src/fields/baseTypes.ts:518

The JSDoc comment on the generated document interface property

Inherited from

BaseFieldInput.interfaceDescription

---

items

items: AdminDataField

Defined in: packages/core/src/fields/array/types.ts:87

---

label?

optional label?: string

Defined in: packages/core/src/fields/baseTypes.ts:507

Display label for the field in the admin form.

Inherited from

BaseFieldInput.label

---

max?

optional max?: FieldLimitInput

Defined in: packages/core/src/fields/array/types.ts:91

Maximum array length.

See

FieldLimitInput

---

meta?

optional meta?: TFieldMeta

Defined in: packages/core/src/fields/baseTypes.ts:546

Inherited from

BaseFieldInput.meta

---

min?

optional min?: FieldLimitInput

Defined in: packages/core/src/fields/array/types.ts:89

Minimum array length.

See

FieldLimitInput

---

required?

optional required?: boolean

Defined in: packages/core/src/fields/baseTypes.ts:524

Whether this field is required.

Default: false

Inherited from

BaseFieldInput.required

Methods

validate()?

optional validate(props): void | Promise<void>

Defined in: packages/core/src/fields/array/types.ts:93

Server-only async validation with value typed as TArrayType[].

Parameters

props

FieldValidateProps<TCollectionSlug, TArrayType[]>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseFieldInput.validate