npm package: @plume-ui/react
Description: React component library for onchain applications
Author: Javi
Latest version: 0.1.0

This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

# Plume UI

A modern React component library for onchain applications.

## Installation

```bash
npm install @plume-ui/react
```

## Usage

```tsx
import { Button } from "@plume-ui/react";

function App() {
  return <Button variant="primary">Click me</Button>;
}
```

## Requirements

This library requires the following peer dependencies:

```json
{
  "react": "^19.0.0",
  "react-dom": "^19.0.0"
}
```

## Styling

Plume UI is built with Tailwind CSS. To use the components, you need to:

1. Install Tailwind CSS in your project if you haven't already:

```bash
npm install -D tailwindcss postcss autoprefixer
```

2. Add the following to your `tailwind.config.js`:

```js
module.exports = {
  content: [
    // ... your project files
    "./node_modules/@plume-ui/react/dist/**/*.{js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {
      colors: {
        // Base colors
        background: "var(--background)",
        foreground: "var(--foreground)",

        // Neutral scale
        neutral: {
          50: "var(--neutral-50)",
          // ... other neutral colors
        },

        // Surfaces
        surface: {
          primary: "var(--surface-primary)",
          secondary: "var(--surface-secondary)",
          tertiary: "var(--surface-tertiary)",
        },

        // Interactive
        primary: {
          DEFAULT: "var(--primary)",
          hover: "var(--primary-hover)",
          light: "var(--primary-light)",
        },

        // Status colors
        success: {
          DEFAULT: "var(--success)",
          light: "var(--success-light)",
        },
        warning: {
          DEFAULT: "var(--warning)",
          light: "var(--warning-light)",
        },
        error: {
          DEFAULT: "var(--error)",
          light: "var(--error-light)",
        },
      },
    },
  },
};
```

## Components

Plume UI includes the following components:

- `Accordion`
- `Alert`
- `Avatar`
- `Badge`
- `Button`
- `Card`
- `Checkbox`
- `DataTable`
- `Dialog`
- `DropdownMenu`
- `Input`
- `RadioGroup`
- `Slider`
- `Switch`
- `Tabs`
- `Textarea`
- `Toast`

## License

MIT © [Javi]