MagnusPladsen / basekit-ui

Simple base UI component library for REACT – install and use it immediately, no configuration required.
https://basekitui.pladsen.dev/
MIT License
1 stars 0 forks source link

BaseKit-UI

Simple base UI component library for REACT – install and use it immediately, no configuration required.

DOCS: https://basekitui.pladsen.dev/

Whether you're a React novice or seasoned pro, our library offers modern, stylish components that are effortlessly customizable – no expertise required.

BaseKit-UI is a versatile and customizable UI component library focused on open-source collaboration, clean UI design, and extensive customization options. With BaseKitUI, you can easily integrate pre-styled base components into your projects using JavaScript object styling, making it compatible with any project setup.

The components are based on Shadcn/UI but upgraded with additonal features and customization options.

The icons are from Lucide.

Features

Base Components: A collection of essential base components styled and ready to use out of the box. JavaScript Object Styling: Utilize JavaScript object styling to customize components to fit seamlessly into your project. Extensive Customization: BaseKitUI offers a wide range of customization options, allowing you to tailor components to your specific design requirements. Open-Source Collaboration: Built with open-source collaboration in mind, FlexiBaseKit-UI encourages contribution and community-driven development.

Components

BaseKitUI is under development and will be updated with new components regularly. The current components include:

Installation

To install BaseKitUI, run the following command: npm install basekit-ui

Usage

To use BaseKitUI components in your project, import the desired component and add it to your project. For example, to use the Button component:

import { Button } from 'basekit-ui';

function App() {
  return (
    <Button>Test button</Button>
  );
}

Documentation

For detailed information on how to use BaseKitUI components, refer to the documentation. Read documentation

Contributing

We welcome contributions from the community! Fork the repository, make your changes, and submit a pull request. We appreciate your input and look forward to your contributions.

License

BaseKitUI is open-source software licensed under the MIT License. Use is permitted for any purpose, including commercial applications, at no cost. The only requirement is that you include the license in your project.