# BadgeConfig

interface

The badge configuration options.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ui/src/badge/badge.ts#L312)

<a id="properties">

## Properties

<a id="member-horizontalOffset">

### `horizontalOffset: number`

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ui/src/badge/badge.ts#L348)

Defaults to `5`

<a id="member-position">

### `position: 'border' | 'inside'`

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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ui/src/badge/badge.ts#L322)

Defaults to `'border'`

<a id="member-side">

### `side: 'right' | 'left'`

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

**Note:** If [`config.language`](module_core_editor_editorconfig-EditorConfig.md#member-language) is set to an RTL (right-to-left) language, the side switches to `'left'` by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ui/src/badge/badge.ts#L332)

Defaults to `'right'`

<a id="member-verticalOffset">

### `verticalOffset: number`

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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ui/src/badge/badge.ts#L341)

Defaults to `5`

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)