@jsburbano-dev/payflux
Version:
A modern and customizable component library built with Vue 3 and Tailwind CSS, designed for building financial dashboards and modern web apps with ease.
97 lines (75 loc) โข 1.85 kB
Markdown
# @jsburbano-dev/payflux
A modern and customizable component library built with Vue 3 and Tailwind CSS, designed for building financial dashboards and modern web apps with ease.
## ๐ฆ Features
- โก๏ธ Vue 3 Composition API support
- ๐จ Tailwind CSS 4.x ready
- ๐ Dark mode support
- ๐ฑ Fully responsive components
- ๐งช Storybook integration with Vitest
- ๐ Finance-focused UI elements
- ๐ Easy to integrate and extend
## ๐งฉ Available Components
- `GridIconCard`
- `IconCard`
- `Card`
- `HeaderTop`
- `KpiCard`
- `BalanceStats`
- `StatusPill`
- `CreditScoreIndicator`
- `MoneyInput`
- `InfoItemsList`
- `DonutChart`
## ๐ Installation
```bash
npm install @jsburbano-dev/payflux
# or
yarn add @jsburbano-dev/payflux
```
## ๐ง Usage
```ts
// main.ts
import { createApp } from "vue";
import App from "./App.vue";
import "@jsburbano-dev/payflux/dist/style.css";
import {
GridIconCard,
IconCard,
Card,
HeaderTop,
KpiCard,
BalanceStats,
StatusPill,
CreditScoreIndicator,
MoneyInput,
InfoItemsList,
DonutChart,
} from "@jsburbano-dev/payflux";
const app = createApp(App);
app.component("GridIconCard", GridIconCard);
app.component("IconCard", IconCard);
app.component("Card", Card);
app.component("HeaderTop", HeaderTop);
app.component("KpiCard", KpiCard);
app.component("BalanceStats", BalanceStats);
app.component("StatusPill", StatusPill);
app.component("CreditScoreIndicator", CreditScoreIndicator);
app.component("MoneyInput", MoneyInput);
app.component("InfoItemsList", InfoItemsList);
app.component("DonutChart", DonutChart);
app.mount("#app");
```
## ๐ Storybook
```bash
yarn storybook
```
## ๐งช Test
```bash
yarn test
```
## ๐ฆ Build for Production
```bash
yarn build
```
## ๐ License
MIT โ Built with โค๏ธ by [@jsburbano-dev](https://www.npmjs.com/~jsburbano-dev)