0.2.3 • Published 5 months ago

@mild-ui/react v0.2.3

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

@mild-ui/react

React implementation of mild-ui component library.

Overview

@mild-ui/react provides React components from the mild-ui library, a cross-framework UI component library inspired by the copy-paste approach of shadcn/ui. Components are designed to be copied into your project, not imported as dependencies.

Installation

This package is typically not installed directly. Instead, use the CLI to add components to your project:

# Install the CLI globally
npm install -g @mild-ui/cli

# Initialize mild-ui in your project
mild-ui init

# Add components to your project
mild-ui add button

Usage

If you've added components using the CLI, you can import them directly from your components folder:

import { Button } from "./components/Button";
import { Plus, ArrowRight } from "lucide-react";

function App() {
  return (
    <div>
      <Button>Default Button</Button>
      <Button variant="secondary">Secondary Button</Button>
      <Button
        variant="outline"
        size="large"
        leadingIcon={<Plus size={16} />}
        trailingIcon={<ArrowRight size={16} />}
      >
        Button with Icons
      </Button>
    </div>
  );
}

Available Components

  • Button

More components will be added in future releases.

Customization

You can customize components by editing their source code directly in your project. CSS variables can be modified to match your design system.

Documentation

For complete documentation, visit our Storybook site.

License

MIT