# React Kawaii

React Kawaii is an open source library of cute SVG illustrations. Perfect if you want to give some cuteness to your React App.

[![Version](https://img.shields.io/npm/v/react-kawaii.svg?style=flat-square)](https://www.npmjs.com/package/react-kawaii)
![npm](https://img.shields.io/npm/dt/react-kawaii.svg)

<p align="center">
  <img src="https://raw.githubusercontent.com/miukimiu/react-kawaii/main/images/react-kawaii-logo@2x.png"alt="React Kawaii Logo">
</p>

## Install

You can install React Kawaii using npm or Yarn:

```bash
npm install --save react-kawaii
```

or

```bash
yarn add react-kawaii
```

### Usage

Using React Kawaii is easy. Just import the desired component and use it in your React application:

```javascript
import { Planet } from 'react-kawaii';

const Example = () => <Planet size={200} mood="blissful" color="#FDA7DC" />;
```

## Example

<p align="center">
  <img src="https://raw.githubusercontent.com/miukimiu/react-kawaii/main/images/react-kawaii-example.gif?raw=true" alt="React Kawaii Example">
</p>

## Development

Interested in contributing to React Kawaii? Follow these steps to get started:

1. Clone this repository:

   ```bash
   git clone https://github.com/miukimiu/react-kawaii.git
   ```

2. Install dependencies:

   ```bash
   pnpm install
   ```

3. Start development server:

   ```bash
   pnpm dev
   ```

4. Build the library:

   ```bash
   pnpm build
   ```

## Documentation

For detailed documentation and usage examples, visit the [React Kawaii documentation website](https://react-kawaii.vercel.app).

### Components

All components in React Kawaii are SVG illustrations. You can choose from various moods: sad, shocked, happy, blissful, and lovestruck. Additionally, you can customize the color and size of each component.

View the list of components and their properties [here](https://react-kawaii.vercel.app).

## Contributors

A big thank you to all the contributors who have helped improve React Kawaii! See the [list of contributors](https://github.com/miukimiu/react-kawaii/graphs/contributors).