CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

MergeFieldDefinition (merge-fields)

@ckeditor/ckeditor5-merge-fields/src/mergefieldsconfig

typedefobject

Filtering

Properties

  • defaultValue : MergeFieldDataSetValue | undefined

    Default value of the merge field.

    It is used if a value for given merge field has not been provided in a data set and in the default values preview mode.

  • height : number | undefined

    The height of the block merge field in pixels.

    It is used only for merge fields of type block. If unset, the default block merge field height is 120 pixels.

  • id : string

    The unique identifier of the merge field.

    If label is not specified, the ID will be used as a label.

    The list of allowed characters includes: a-z, A-Z, 0-9, _, ., and -.

  • label : string | undefined

    The human-readable label of the merge field.

    It is displayed by the feature's UI and inside the editing area.

  • type : MergeFieldType | undefined

    The type of the merge field. It determines how the merge field is rendered in the editor editing area.

    Possible options are text (meaning the merge field will be inline) and block.