npm package: @hexa-it/qui
Description: Create a reusable Qwik component library
Latest version: 0.1.5

# qUI - Qwik UI Component Library

A comprehensive and lightweight component library for the Qwik framework. qUI stands for Qwik UI, embodying a "batteries-included," intrinsic approach, with a focus on efficiency and performance, keeping the library under 500kb.

## Components

qUI offers a wide range of components, each designed to integrate seamlessly with your Qwik projects. Here's our current lineup:

- Accordion
- Avatar
- Badge
- Button
- ChoiceInput
- ColorInput
- ColorSwatch
- DateInput
- DateTimeInput
- Drawer
- EmailInput
- FileInput
- Floater
- Form
- Group
- Loader
- Modal
- Notification
- NumberInput
- Segments
- Paper
- PinInput
- Popover
- Progress
- RichTextEditor
- SelectInput
- Sheet
- Stack
- Table
- Tabs
- Textarea
- TextInput
- TimeInput
- Title

## Inspiration

Our components draw inspiration from the [Mantine React component library](https://mantine.dev/), a testament to the power and flexibility of modern UI component design. We give full credit to Mantine for paving the way in this domain and providing a solid foundation of ideas and principles that have influenced the development of qUI.

## Philosophy

Despite the growing popularity of headless component libraries, we firmly believe in providing a fully customizable yet comprehensive solution. qUI is not just another headless UI library; it's a full-fledged toolkit designed to empower developers to build beautiful, efficient, and accessible web applications without compromising on control or customizability.

## Intrinsic Props Support

One of the standout features of qUI is its support for intrinsic props, allowing you to customize every component and its sub-elements using the native intrinsic properties of the HTML elements themselves. This approach ensures a high degree of flexibility and adaptability to various design requirements.

## Beta Release and Documentation

Please note that qUI is currently in beta. We are actively working on improving the library and its components. Comprehensive documentation is on our to-do list and will be available soon. Your feedback and contributions during this phase are invaluable and greatly appreciated.

## Getting Started

To start using qUI in your project, you can install it using your preferred package manager:

```sh
npm install @hexa-it/qui
```

```sh
yarn add @hexa-it/qui
```

```sh
pnpm add @hexa-it/qui
```

Once installed, you can directly import and use the components in your Qwik projects.

## Contributing

We welcome contributions to qUI! If you're interested in helping improve the library, please consider the following ways to contribute:

- **Reporting Issues:** If you find a bug or have a suggestion for improvement, please open an issue.
- **Submitting Pull Requests:** We appreciate pull requests. Whether it's fixing a bug, adding a feature, or improving the documentation, your contributions are invaluable.
- **Code Reviews:** Providing feedback on open pull requests is another great way to contribute.

Please read our contribution guidelines for more information on how to submit good pull requests and effectively report issues.

## License

qUI is licensed under the MIT License, a widely used permissive open source license. This license allows for free use, modification, and distribution of the software.

---

Stay tuned for updates, and thank you for exploring qUI - where performance meets elegance in Qwik UI development!