Skip to content

Latest commit

 

History

History
149 lines (126 loc) · 4.47 KB

README.md

File metadata and controls

149 lines (126 loc) · 4.47 KB
Raw

<Awesome React UI Library />

npm downloads Github Stars

Demo

Try using it in playground

Installing WAP-UI

To use WAP UI, Install the wap-ui package and its peer dependencies. (@emotion/react, @emotion/styled, framer-motion)

pnpm add wap-ui @emotion/react @emotion/styled framer-motion
# or
yarn add wap-ui @emotion/react @emotion/styled framer-motion
# or
npm i wap-ui @emotion/react @emotion/styled framer-motion

Usage

To start using the components, follow these steps:

  1. For WAP UI to work correctly, Wrap WapUIProvider provided by wap-ui at root of your application.
import React from 'react';

// 1. import `WapUIProvider` component
import ReactDOM from 'react-dom/client';
import App from './App';
import { WapUIProvider } from 'wap-ui';

// 2. Wrap WapUIProvider at the root of your app
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
  <WapUIProvider>
    <App />
  </WapUIProvider>,
);
  1. Bring components what you want and use them.
import { Button } from 'wap-ui';

const Home = () => {
  return (
    <Button size="md" color="success" shadow>
      버튼
    </Button>
  );
};

export default Home;
  1. You can refer to the components through Documents or Jsdocs like that.
Documents Jsdocs

Contributors


neko113 💻
sjyoung428 💻
mimpie 💻
컴공19 김민수 컴공16 성준영 컴공21 이예슬

Links