CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

MergeFieldDefinition (merge-fields)

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

interface

The definition of a single merge field.

Depending on the type, some of the properties may not be relevant:

  • For text merge fields, the id, label, and defaultValue properties are used.
  • For block merge fields, the id, label, height, and defaultValue properties are used.
  • For image merge fields, the id, label, height, width, and defaultValue properties are used.

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 non-text merge field in pixels.

    It is used only for merge fields of type block and image. If unset, the default height for block is 120 pixels and for image - 400 pixels.

    Defaults to 120 (for block)/ 400 (for image)

  • 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), block and image.

    Defaults to 'text'

  • width : number | undefined

    The width of the image merge field in pixels.

    It is used only for merge fields of type image. If unset, the default width is 400 pixels.

    Defaults to 400