Skip to content

README.md

Latest commit

 

History

History
82 lines (51 loc) · 2.04 KB

README.md

File metadata and controls

82 lines (51 loc) · 2.04 KB
Raw

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 npm

React Kawaii Logo

Install

You can install React Kawaii using npm or Yarn:

npm install --save react-kawaii

or

yarn add react-kawaii

Usage

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

import { Planet } from 'react-kawaii';

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

Example

React Kawaii Example

Development

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

  1. Clone this repository:

    git clone https://github.com/elizabetdev/react-kawaii.git

  2. Install dependencies:

    pnpm install

  3. Start development server:

    pnpm dev

  4. Build the library:

    pnpm build

Documentation

For detailed documentation and usage examples, visit the React Kawaii documentation website.

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.

Contributors

A big thank you to all the contributors who have helped improve React Kawaii! See the list of contributors.