# API of `@koobiq/components/badge`

Documented on [Badge](https://koobiq.io/en/components/badge.md). NgModule: `KbqBadgeModule`.

## Components

### KbqBadge (component)

Component used to highlight the status, count or another important characteristic of an object.

```ts
@Component({ selector: 'kbq-badge' })
class KbqBadge {
    readonly compact = input<boolean>(false);
    readonly outline = input<boolean>(false);
    readonly badgeColor = input<string>(KbqBadgeColors.FadeContrast);
}
```

- `[compact]`: `boolean` — Whether the badge uses the compact size.
- `[outline]`: `boolean` — Whether the badge is outlined instead of filled.
- `[badgeColor]`: `string` — Color of the badge. An empty, `null` or `undefined` value falls back to the default, so a read of the
  signal reports the color the badge actually renders in. Defaults to `'fade-contrast'`.

## Directives

### KbqBadgeCaption (directive)

Directive that marks the caption part of a badge.

```ts
@Directive({ selector: '[kbq-badge-caption]' })
class KbqBadgeCaption {}
```

## Enums

### KbqBadgeColors (enum)

Colors supported by the badge.

```ts
enum KbqBadgeColors {
    FadeContrast = 'fade-contrast',
    FadeTheme = 'fade-theme',
    FadeSuccess = 'fade-success',
    FadeWarning = 'fade-warning',
    FadeError = 'fade-error',
    Contrast = 'contrast',
    Theme = 'theme',
    Success = 'success',
    Warning = 'warning',
    Error = 'error',
    Disabled = 'disabled'
}
```
