# 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.

Latest version **1.6.0** (published 2025-01-26) · 0 weekly downloads

## Install

```sh
npm install react-kawaii
pnpm add react-kawaii
yarn add react-kawaii
bun add react-kawaii
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2025-01-26 |
| First published | 2017-03-09 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 158.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | miukimiu |

## Links

- npm: https://www.npmjs.com/package/react-kawaii
- Homepage: https://github.com/miukimiu/react-kawaii#readme
- npm.io page: https://npm.io/package/react-kawaii

## Recent versions

- 1.6.0 (latest) — 2025-01-26
- 1.5.0 — 2025-01-21
- 1.4.0 — 2024-11-04
- 1.3.1 — 2024-06-11
- 1.3.0 — 2024-06-11
- 1.2.0 — 2024-06-09
- 1.1.0 — 2024-06-09
- 1.0.0 — 2024-06-09
- 0.18.0 — 2022-09-21
- 0.17.0 — 2020-12-11
- 0.16.0 — 2020-02-11
- 0.15.0 — 2020-02-11
- 0.14.4 — 2019-06-12
- 0.14.3 — 2019-06-12
- 0.14.2 — 2019-06-12
- … 30 more at https://npm.io/package/react-kawaii/versions

## README

# 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).

---
_Source: https://npm.io/package/react-kawaii · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._