# Badge

An Orbit component for displaying a badge.

To import the `Badge` component to your project:

```jsx
import { Badge } from '@kiwicom/orbit-react-native';
```

## Usage

```jsx
<Badge>I'm a real badge!</Badge>
```

## Props

Table below contains all types of the props available in Badge component.

| Name               | Type            | Default     | Description                                                                                                    |
| :----------------- | :-------------- | :---------- | -------------------------------------------------------------------------------------------------------------- |
| children           | `React.Node`    |             | The content of the Badge.                                                                                      |
| testID             | `string`        |             | Optional prop for testing purposes. (This disables the 'layout-only view removal' optimization for this view!) |
| icon               | `React.Node`    |             | The displayed icon on the left.                                                                                |
| type               | [`enum`](#enum) | `"neutral"` | The color type of the Badge.                                                                                   |
| accessibilityLabel | `string`        |             | Adds prop adds `accessibilityLabel` to an element, useful for screen readers.                                   |

### enum

| type                 |
| :------------------- |
| `"neutral"`          |
| `"dark"`             |
| `"info"`             |
| `"success"`          |
| `"warning"`          |
| `"critical"`         |
| `"infoInverted"`     |
| `"criticalInverted"` |
| `"successInverted"`  |
| `"warningInverted"`  |