BlockConfig
Defined in: packages/core/src/fields/blocks/types.ts:128
Resolved block type definition, after defineBlock() applies all defaults.
- BlockConfigInput for the user-facing input type
- defineBlock for the config function that produces this type
Type Parameters
Section titled “Type Parameters”TBlockMeta
Section titled “TBlockMeta”TBlockMeta extends object = { }
Properties
Section titled “Properties”admin?
Section titled “admin?”
optionaladmin?:BlockAdminConfig
Defined in: packages/core/src/fields/blocks/types.ts:138
Admin UI configuration.
blockName?
Section titled “blockName?”
optionalblockName?:string
Defined in: packages/core/src/fields/blocks/types.ts:131
blockType
Section titled “blockType”blockType:
string
Defined in: packages/core/src/fields/blocks/types.ts:130
Unique discriminant value stored as blockType on every block item.
fields
Section titled “fields”fields:
Record<string,AdminField>
Defined in: packages/core/src/fields/blocks/types.ts:136
Fields that make up this block’s data shape.
id:
string
Defined in: packages/core/src/fields/blocks/types.ts:132
interfaceName
Section titled “interfaceName”interfaceName:
string
Defined in: packages/core/src/fields/blocks/types.ts:144
TypeScript interface name for this block type.
Always set after defineBlock(). Defaults to ${slugToPascalCase(slug)}Block.
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/blocks/types.ts:151
Computed TypeScript object-type string including all three framework keys.
E.g. { blockType: "heading"; blockName?: string; id: string; text: string }.
Used by getFieldInterfaces to emit the block’s export type declaration.
label?
Section titled “label?”
optionallabel?:string
Defined in: packages/core/src/fields/blocks/types.ts:134
Display label shown in the admin block-type picker.
metadata?
Section titled “metadata?”
optionalmetadata?:TBlockMeta
Defined in: packages/core/src/fields/blocks/types.ts:152