BadgeConfig
interface
The badge configuration options.
Properties
-
horizontalOffset : number
module:ui/badge/badge~BadgeConfig#horizontalOffset
The horizontal distance between the side of the editing root and the nearest side of the badge.
Defaults to
5
-
position : 'border' | 'inside'
module:ui/badge/badge~BadgeConfig#position
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'
- When
-
side : 'right' | 'left'
module:ui/badge/badge~BadgeConfig#side
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
module:ui/badge/badge~BadgeConfig#verticalOffset
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