BlocksField

Defined in: packages/core/src/fields/blocks/types.ts:260

Resolved configuration for a blocks() field, after all defaults are applied.

See

• BlocksFieldInput for the user-facing input type
• blocks for the config function that produces this type

Extends

• BaseField<TCollectionSlug, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends object = { }

Properties

admin

admin: BlocksFieldAdminConfig<TCollectionSlug>

Defined in: packages/core/src/fields/blocks/types.ts:265

Resolved admin UI configuration with all defaults applied.

Overrides

BaseField.admin

---

blocks

blocks: BlockConfig<TFieldMeta>[]

Defined in: packages/core/src/fields/blocks/types.ts:267

Block type definitions allowed in this field.

---

defaultValue

defaultValue: Record<string, unknown>[]

Defined in: packages/core/src/fields/blocks/types.ts:277

Pre-filled value when creating a new document.

Overrides

BaseField.defaultValue

---

description?

optional description?: string

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

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

BaseField.description

---

index?

optional index?: ResolvedFieldIndexConfigInput

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

Convex index name for this field, or the object form for a compound index.

Inherited from

BaseField.index

---

interfaceDescription?

optional interfaceDescription?: string

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

The JSDoc comment on the generated document interface property

Inherited from

BaseField.interfaceDescription

---

interfaceName?

optional interfaceName?: string

Defined in: packages/core/src/fields/blocks/types.ts:269

Optional TypeScript union alias name.

---

interfaceType

interfaceType: string

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

TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").

Inherited from

BaseField.interfaceType

---

label

label: string

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

Display label shown in the admin form. Always set — inferred from the field key if not provided.

Inherited from

BaseField.label

---

labels

labels: object

Defined in: packages/core/src/fields/blocks/types.ts:275

Singular/plural display labels for the admin UI.

plural

plural: string

singular

singular: string

---

max?

optional max?: FieldLimit

Defined in: packages/core/src/fields/blocks/types.ts:273

Maximum number of block items, with its resolved error message (Zod-enforced).

See

FieldLimit

---

meta

meta: TFieldMeta

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

Inherited from

BaseField.meta

---

min?

optional min?: FieldLimit

Defined in: packages/core/src/fields/blocks/types.ts:271

Minimum number of block items, with its resolved error message (Zod-enforced).

See

FieldLimit

---

required

required: boolean

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

Whether this field is required in the database schema.

Inherited from

BaseField.required

---

type

readonly type: "blocks"

Defined in: packages/core/src/fields/blocks/types.ts:264

Methods

validate()?

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

Defined in: packages/core/src/fields/blocks/types.ts:279

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

Parameters

props

FieldValidateProps<TCollectionSlug, GenericBlock[]>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseField.validate