Giter VIP home page Giter VIP logo

react-kawaii's Introduction

React Kawaii

Version npm

Welcome to React Kawaii! This repository contains both the website and the React package.

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

React Kawaii Logo

Website

The website for React Kawaii is located in the apps/website directory. It serves as a documentation hub and may also include demos, tutorials, and other resources related to the project.

To start the website locally:

  1. Navigate to the apps/website directory.
  2. Install dependencies with pnpm install.
  3. Run the development server with pnpm start.

React Package

The React package, named react-kawaii, is located in the packages/react-kawaii directory. It contains the source code for the React components.

To use the react-kawaii package in your projects:

  1. Install it from npm or yarn:

    npm install --save react-kawaii
    

    or

    yarn add react-kawaii
    
  2. Import the components you need in your React application:

    import { Planet } from 'react-kawaii';
    
    const MyComponent = () => {
      return <Planet size={200} mood="blissful" color="#FDA7DC" />;
    }

Example

React Kawaii Example

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

Contributing

Contributions to React Kawaii are welcome! Feel free to open issues or pull requests if you have any suggestions, bug fixes, or improvements.

License

This project is licensed under the MIT License.

react-kawaii's People

Contributors

aliciacatalina avatar codenakama avatar dependabot[bot] avatar eliasparis avatar iaurg avatar italodeandra avatar kombucha avatar lachlanjc avatar langoliver avatar miukimiu avatar pducolin avatar saravieira avatar sueannioanis avatar txbrown avatar uselessdev avatar vinnl avatar yuanchuan avatar yuriettys avatar zhangyijiang avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

react-kawaii's Issues

TypeScript declaration files

Hi,

I have been adding some "kawaii-ness" to a typescript project that I am working on, but have run into a small problem - there is no TypeScript declaration file for react-kawaii. I have built a custom declaration file that defines only the components that I am using as a work-around. Are there any plans to add a declaration file in the near future?

Add support for server side rendered apps

Currently the package blows up when importing on a server-side rendered framework such as Nextjs.
ReferenceError: window is not defined

I am also curious about the dependency on the window object considering that its just a "dumb" component. @miukimiu I'll investigate this soon.

Import not working when using react-native, workaround included.

Hello :)

When using the library with Expo like so:

expo init kawaiitest
cd kawaiitest
yarn add https://github.com/miukimiu/react-kawaii.git#new-site-and-react-native

Adding this to the main page:

import { Planet } from 'react-kawaii/native';
const Example = () => <Planet size={200} mood="blissful" color="#FDA7DC" />;

There is an import error on this line:

import paths from 'react-native-kawaii/src/components/common/face/paths';

If you modify that line to read:

import paths from 'react-kawaii/src/components/common/face/paths';

Everything works fine, am I importing things wrong or is this a bug?

Add a face for musical projects

Hello,
Thank you for this great library.

Our musical startup uses it in an open-source project named OpenJam. :)

Speaking of music, would it be possible to add a musical instrument? I imagined a paperclip / trombone like Microsoft's Clippy... or maybe a synthesizer.

What do you think?

Shouldn't the kawaii face be a separated component ?

I understand that some character might have different faces. But for those that share the same, it would be good to have a separated component to avoid duplicated code.

If there isn't a reason to each character having its own implementation, I would gladly do a PR for it.

Dependency Conflict installing kawaii

How does one resolve this dependency error in order to use react-kawaii

$ npm i react-kawaii
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/react
npm ERR!   react@"^17.0.2" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer react@"15.3.0 - 16.x" from [email protected]
npm ERR! node_modules/react-kawaii
npm ERR!   react-kawaii@"*" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /home/kingram/.npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/kingram/.npm/_logs/2021-03-30T02_46_24_195Z-debug.log

Why is this a dev dependency?

Hi. I noticed the instructions say to install this module with npm install --save-dev. Shouldn't this be npm install?

React does not recognize the hoverState and showTextOnHover props

Chrome console errors while running "react": "^16.3.2":

index.js:2178 Warning: React does not recognize the hoverStateprop on a DOM element. If you intentionally want it to appear in the DOM as a custom attribute, spell it as lowercasehoverstate instead. If you accidentally passed it from a parent component, remove it from the DOM element.

React does not recognize the showTextOnHoverprop on a DOM element. If you intentionally want it to appear in the DOM as a custom attribute, spell it as lowercaseshowtextonhover instead. If you accidentally passed it from a parent component, remove it from the DOM element.

Feature request - extend animation

Extend elements so they take props like eyes, mouth and nose in order to extend animations to control each element more accurately.

I suppose using a className to target each element works, but it's not declarative nor dynamic.

What do you think?

Apologies if this is already implemented but I couldn't find any documentation on how to animate and the cds link is broken

More components?

Hi!

This is amazing!

Are you gonna make any more components? Want help?

react native app on IOS crashed

My native react app keep crashed.
After a few days of debugging, I realized that this was caused by the lack of id attribute on the Mask tag of SpeechBubble

<Mask fill="#fff">...

I think that on new versions of react-native-svg the id-attribut is required for the Mask

react-native-svg: 12.1.1

React 18 support

To install react-kawaii when using the two latest major releases of react requires you to use npm install react-kawaii --legacy-peer-deps. It would be great if we could bump dependency requirements so it can be installed by npm install react-kawaii. I can supply a PR!

Add a stack of new faces.

Hi @miukimiu !
I was spinning around here and came into my mind the idea of using some of the kawaii components but with a kind of dizzy or shocked face (like for a 404 error page or something). Right after I realized that it would be awesome to have a full emojipedia faces styled available in this project.

That for, I would like to add some new styled faces to it.
My doubts are:

  • Maybe lots of emoji faces are out of scope of kawaii as they are not exactly "cute".
  • The more the faces the bigger the file. Maybe it leads to an unreadable Face component in the end.

Cheers!

Bump version + push to NPM?

I'm trying to use this in a Next.js project and I can't because window is not defined in development. There's certainly ways around this. It looks like this issue has been addressed in later versions of your package, but the later versions haven't been updated.

Is there any chance you could upload the latest version to NPM?

Is Yarn or npm preferred?

The repo currently has both yarn.lock and package-lock.json. It is not a good idea to use both since they may go out of sync - can I check which is preferred, and have the lockfile used by the other package manager deleted?

Package components as ES6 classes

Currently because of the way this library is packaged as UMD, importing any component from the library will cause the all components to be imported. It would be great if the components can also be built as ES6 and made available under the modules entry point in package.json so that ES6 aware bundlers can shake away unused components.

File component path is not centered

Hi, first let me say thanks for the great library!

As you can see in this sandbox, unlike any other component, File is not centered (contains a lot of whitespace on its right). Is there any way to remove the whitespace programmaticaly?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.