@kiwicom/orbit-components/lib/RatingStars/README.md

Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.

# RatingStars

To implement RatingStars component into your project you'll need to add the import:

```jsx
import RatingStars from "@kiwicom/orbit-components/lib/RatingStars";
```

After adding import into your project you can use it simply like:

```jsx
<RatingStars rating={3} size="medium" color="attention" showEmpty />
```

## Props

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

| Name       | Type            | Default     | Description                         |
| :--------- | :-------------- | :---------- | :---------------------------------- |
| color      | [`enum`](#enum) | `"primary"` | The color of stars.                 |
| dataTest   | `string`        |             | Optional prop for testing purposes. |
| size       | [`enum`](#enum) | `"small"`   | The size of stars.                  |
| showEmpty  | `boolean`       | `false`     | Show empty stars.                   |
| **rating** | `number`        |             | The rating number to display.       |

### enum

| size       | color         |
| :--------- | :------------ |
| `"small"`  | `"primary"`   |
| `"medium"` | `"secondary"` |
| `"large"`  |