npm

mareana-ui

0.0.0 • Public • Published

Custom Component Library

This is a custom component library built on top of shadcn/ui and Tailwind CSS, providing a set of reusable UI components for your web applications.

Installation

To install the package, run the following command:

npm install @your-company/custom-components

Usage

To use a component from the library, import it into your React component:

import { Button } from '@your-company/custom-components';

const MyComponent = () => {
  return (
    <div>
      <Button variant="primary">Click me</Button>
    </div>
  );
};

Components

The library provides the following components:

  • Button: A customizable button component with different variants and styles.
  • Card: A versatile card component for displaying content.
  • Modal: A modal component for displaying modals and overlays.
  • Dropdown: A dropdown menu component.
  • Tooltip: A tooltip component for displaying additional information.
  • ...

Each component has its own set of props and customization options. Refer to the component documentation for more details.

Theming

The component library supports theming through Tailwind CSS. You can customize the styles by overriding the default Tailwind configuration in your project. Refer to the theming documentation for more information.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Readme

Keywords

none

Package Sidebar

Install

npm i mareana-ui

Weekly Downloads

1

Version

0.0.0

License

none

Unpacked Size

5.25 kB

Total Files

3

Last publish

Collaborators

  • questowls