# kunci-ui

> KunciLab UI kit -- Made for Kunci Ecosystem

Latest version **0.0.13** (published 2022-09-27) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.13 |
| Published | 2022-09-27 |
| First published | 2022-09-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 823.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | KunciLab |
| Maintainers | devoresyah, darekaze |

## Links

- npm: https://www.npmjs.com/package/kunci-ui
- npm.io page: https://npm.io/package/kunci-ui

## Dependencies (4)

- [clsx](https://npm.io/package/clsx.md) ^1.2.1
- [@tippyjs/react](https://npm.io/package/@tippyjs/react.md) ^4.2.6
- [tailwind-merge](https://npm.io/package/tailwind-merge.md) ^1.6.0
- [@tailwindcss/forms](https://npm.io/package/@tailwindcss/forms.md) ^0.5.3

## Recent versions

- 0.0.13 (latest) — 2022-09-27
- 0.0.12 — 2022-09-21
- 0.0.11 — 2022-09-20
- 0.0.10 — 2022-09-20
- 0.0.9 — 2022-09-20
- 0.0.8 — 2022-09-20
- 0.0.7 — 2022-09-16
- 0.0.6 — 2022-09-14
- 0.0.5 — 2022-09-13
- 0.0.4 — 2022-09-12
- 0.0.3 — 2022-09-08
- 0.0.2 — 2022-09-07
- 0.0.1 — 2022-09-06

## README

# Kunci UI

Kunci React components library

## 🚀 Usage

> Note: Kunci UI depends on tailwindcss, please follow [this guide](https://tailwindcss.com/docs/installation/framework-guides) before moving on.

Install

```sh
yarn add kunci-ui
```

Inside `tailwind.config.js`

```js
/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    "./src/**/*.{js,ts,jsx,tsx}",
    "node_modules/kunci-ui/dist/kunciui.es.js",
  ],
  theme: {
    extend: {},
  },
  plugins: [],
}
```

Then, you can use components inside your project:

```js
import { Button } from 'kunci-ui'

function App() {
  return <Button>Hi there!</Button>
}

export default App
```

## 🔌 Contributing

We use storybook for developing components, to start:

```sh
# Install dependencies
yarn install

# Run Storybook for development
yarn dev
```

To test the package, you can build a package and test it in other projects.

<!-- TODO: create a example playground for testing package? -->

```bash
# Build
yarn build

# Pack and publish...
yarn pack
```

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