component-jar

Component Jar

A collection of Vue 3 components built using Tailwind CSS.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The internet is over saturated with awesome component libraries for Vue 3, so I'm adding another one to the mix.

My primary reasons for creating this library are:

• I have my own opinions about style
• I tend to carry those opinions over from project to project
• I want to save some time for myself (and others)
• Many of the freemium offerings tend to hide access to the "goods" behind a paywall, which for me often translates to components like:
  • Column manager
  • AJAX Typeahead
  • Advanced filter / Query builder
  • ...and other enterprise-level components

Use this library if it appeals to your needs.
Pull requests welcome.
General input on the architecture welcome.
Feel free to help me improve this library.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 

(back to top)

Getting Started

The main branch supports Vue 3 only, and thus please make sure you are installing this into an environment that uses Vue 3.

Note
This library is based on the cutting edge versions of the stack that it is intended to be used within. For example, the version of Headless Vue is the insiders version. That is to say that this library should only be used with projects where it is understood that support may be limited.

Prerequisites

TODO

Installation

• via NPM

  npm install component-jar

• via Yarn

  yarn add component-jar

(back to top)

Usage

TODO

(back to top)

Roadmap

• [ ] Add Changelog
• [ ] Add Vitepress documentation
• [ ] Add config for component style customization

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/picklepilot/pickle-jar

(back to top)

Acknowledgments

TODO

(back to top)