# wap-ui

> WAP UI / React UI Components Library

Latest version **2.0.31** (published 2023-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install wap-ui
pnpm add wap-ui
yarn add wap-ui
bun add wap-ui
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.31 |
| Published | 2023-08-28 |
| First published | 2023-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | neko113 |
| Maintainers | alstn113 |
| Keywords | react, emotion, framer-motion, ui, components, react-component-library, react-ui-kit, wap, design-system |

## Links

- npm: https://www.npmjs.com/package/wap-ui
- Repository: https://github.com/pknu-wap/wap-ui
- npm.io page: https://npm.io/package/wap-ui

## Dependencies (6)

- [react](https://npm.io/package/react.md) ^18.2.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.30.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [framer-motion](https://npm.io/package/framer-motion.md) ^7.3.6
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.10.4
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.10.4

## Alternatives

- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K weekly downloads
- [persona-harness](https://npm.io/package/persona-harness.md) — 4.7K weekly downloads
- [@tsparticles/effect-bubble](https://npm.io/package/@tsparticles/effect-bubble.md) — 4.6K weekly downloads
- [f3d](https://npm.io/package/f3d.md) — 730 weekly downloads
- [spark-html-motion](https://npm.io/package/spark-html-motion.md) — 298 weekly downloads

## Recent versions

- 2.0.31 (latest) — 2023-08-28
- 2.0.3 — 2023-08-27
- 2.0.2 — 2023-05-30

## README

<div align="center"><img src="https://user-images.githubusercontent.com/75781414/192261497-b3e4b288-d1c5-4d27-a062-da65a876ecfb.png" width="220" height="240">
</div>

# <div align="center">&lt;Awesome React UI Library /&gt;</div>

<p align="center">
  <a href="https://github.com/pknu-wap/wap-ui/blob/main/LICENSE">
    <img src="https://badgen.net/github/license/pknu-wap/wap-ui">
  </a>
  <a href="https://www.npmjs.com/package/wap-ui">
    <img src="https://img.shields.io/npm/dm/wap-ui.svg?style=flat-round" alt="npm downloads">
  </a>
  <img alt="Github Stars" src="https://badgen.net/github/stars/pknu-wap/wap-ui" />
  <img src="https://badgen.net/github/release/pknu-wap/wap-ui">

</p>
<p align="center">
  <img src="https://badgen.net/github/issues/pknu-wap/wap-ui">
  <img src="https://badgen.net/github/prs/pknu-wap/wap-ui">
  <img src="https://badgen.net/github/contributors/pknu-wap/wap-ui">
</p>

## `Demo`

<table align="center" width="100%">
  <tr align="center">
    <td colspan="2">
      <a href="https://wap-ui.vercel.app/?path=/story/components-button--default">Try using it in playground</a>
    </td>
  </tr>
  <tr>
    <td width="50%">
      <img src="https://user-images.githubusercontent.com/75781414/209572114-dfa9b08a-052b-446e-afd5-388545d09c6b.gif"  />
    </td>
    <td width="50%">
      <img src="https://user-images.githubusercontent.com/75781414/209572876-2720e0ef-94bb-441d-b24e-b282fefc683d.gif" />
    </td>
  </tr>
  </tr>
</table>

## `Installing WAP-UI`

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

```sh
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.

```tsx
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>,
);
```

2. Bring components what you want and use them.

```tsx
import { Button } from 'wap-ui';

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

export default Home;
```

3. You can refer to the components through Documents or Jsdocs like that.
<table align="center">
  <tr>
    <td align="center">
      Documents
    </td>
    <td align="center">
      Jsdocs
    </td>
  </tr>
  <tr>
    <td align="center" >
      <img src="https://user-images.githubusercontent.com/75781414/209562964-ae0b74b4-c604-4ac7-94d6-b5f0a3cb4a02.png" width="100%" />
    </td>
    <td align="center">
      <img src="https://user-images.githubusercontent.com/75781414/209560523-74cb3b4e-f1e9-4a5d-a5e1-ae54c2aa4150.png" width="100%" />
    </td>
  </tr>  
</table>

## `Contributors`

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/neko113">
        <img src="https://avatars.githubusercontent.com/u/75781414?v=4" width="120px;"/>
        <br />
        <a href="https://github.com/pknu-wap/wap-ui/commits/main?author=neko113" title="Code">neko113 💻</a>
    </td>
    <td align="center">
      <a href="https://github.com/sjyoung428">
        <img src="https://avatars.githubusercontent.com/u/77968955?v=4" width="120px;"/>
        <br />
        <a href="https://github.com/pknu-wap/wap-ui/commits/main?author=sjyoung428" title="Code">sjyoung428 💻</a>
    </td>
    <td align="center">
      <a href="https://github.com/mimpie">
        <img src="https://avatars.githubusercontent.com/u/108365477?v=4" width="120px;"/>
        <br />
        <a href="https://github.com/pknu-wap/wap-ui/commits/main?author=mimpie" title="Code">mimpie 💻</a>
    </td>
  </tr>
  <tr>
    <td align="center">컴공19 김민수</td>
    <td align="center">컴공16 성준영</td>
    <td align="center">컴공21 이예슬</td>
  </tr>
</table>

## `Links`

- #### [Documents](https://github.com/pknu-wap/wap-ui/tree/main/docs)
- #### [NPM](https://www.npmjs.com/package/wap-ui)
- #### [Playground](https://wap-ui.vercel.app/)
- #### [Presentations](https://github.com/pknu-wap/wap-ui/tree/main/ppt)
- #### [Example](https://github.com/pknu-wap/wap-ui/tree/main/example)

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