CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

BadgeConfig (ui/badge)

@ckeditor/ckeditor5-ui/src/badge/badge

interface
See source

The badge configuration options.

Filtering

Properties

  • horizontalOffset : number

    See source

    The horizontal distance between the side of the editing root and the nearest side of the badge.

    Defaults to 5

  • position : 'border' | 'inside'

    See source

    The position of the badge.

    • When 'inside', the badge will be displayed within the boundaries of the editing area.
    • When 'border', the basge will be displayed over the bottom border of the editing area.

    Defaults to 'border'

  • side : 'right' | 'left'

    See source

    Allows choosing the side of the editing area where the badge will be displayed.

    Note: If config.language is set to an RTL (right-to-left) language, the side switches to 'left' by default.

    Defaults to 'right'

  • verticalOffset : number

    See source

    The vertical distance the badge can be moved away from its default position.

    Note: If position is 'border', the offset is measured from the (vertical) center of the badge.

    Defaults to 5