BlocksField
Defined in: packages/core/src/fields/blocks/types.ts:243
Resolved configuration for a blocks() field, after all defaults are applied.
- BlocksFieldInput for the user-facing input type
- blocks for the config function that produces this type
Extends
Section titled “Extends”BaseField<TFieldMeta>
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
Properties
Section titled “Properties”admin:
FieldAdminConfig&object
Defined in: packages/core/src/fields/blocks/types.ts:247
Resolved admin UI configuration with all defaults applied.
Type Declaration
Section titled “Type Declaration”defaultCollapsed
Section titled “defaultCollapsed”defaultCollapsed:
boolean
Overrides
Section titled “Overrides”blocks
Section titled “blocks”blocks:
BlockConfig<TFieldMeta>[]
Defined in: packages/core/src/fields/blocks/types.ts:251
Block type definitions allowed in this field.
defaultValue
Section titled “defaultValue”defaultValue:
Record<string,unknown>[]
Defined in: packages/core/src/fields/blocks/types.ts:261
Pre-filled value when creating a new document.
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
interfaceName?
Section titled “interfaceName?”
optionalinterfaceName?:string
Defined in: packages/core/src/fields/blocks/types.ts:253
Optional TypeScript union alias name.
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”label:
string
Defined in: packages/core/src/fields/baseTypes.ts:234
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Inherited from
Section titled “Inherited from”labels
Section titled “labels”labels:
object
Defined in: packages/core/src/fields/blocks/types.ts:259
Singular/plural display labels for the admin UI.
plural
Section titled “plural”plural:
string
singular
Section titled “singular”singular:
string
optionalmax?:number
Defined in: packages/core/src/fields/blocks/types.ts:257
Maximum number of block items (Zod-enforced).
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”
optionalmin?:number
Defined in: packages/core/src/fields/blocks/types.ts:255
Minimum number of block items (Zod-enforced).
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:236
Whether this field is required in the database schema.
Inherited from
Section titled “Inherited from”
readonlytype:"blocks"
Defined in: packages/core/src/fields/blocks/types.ts:246