SoliBee

Description

Speed up your SolidJS development with open-source, fully tested & customizable UI components.

Features

• Easy to use: To get started with Solibee please visit our documentation for user-friendly customizable component previews and installation guides.
• Customizable: All Solibee components are built using Solid JS and styled with Tailwind CSS which ensures that each component is easily customizable to fit the design and needs of your project.
• Accessible: Solibee component library is designed with accessibility in mind to ensure that all our users can interact with the components. Our components follow WAI-ARIA design patterns.
• Documented: Comprehensive documentation provided for each component to facilitate easy usage and understanding.
• Reliable: Solibee custom components are written in JavaScript or TypeScript and tested with Jest and Solid JS Testing library.
• Opportunities to contribute: Solibee is an open-source project built for the Solid JS community. If you have any questions, feedback, or suggestions, please visit our github .

Usage

Solibee CLI to help you get started quickly. To use a component in your project please follow the steps below:

• Run the following command in your terminal. Substitute ComponentName with the name of the custom component you would like to use. You can see the preview and the full list of components here.

npx solibee create-[ComponentName]

• When you run the CLI command above it will automatically install all dev dependencies.

• After successful installation you will find a new Solibee directory created in your root folder. This directory will contain a CustomComponent, Tailwind.config, PostCSS.config files.

• Configure dev dependencies:

  • If you don't have Tailwind.config and PostCSS.config files in the root directory, bring Tailwind.config and PostCSS.config files from Solibee directory to your root directory.
  • If you have existing Tailwind.config and PostCSS.config files in your root directory, integrate Tailwind and PostCSS configurations installed with Solibee.

• Configure Tailwind styles

  • Add the following to your global CSS styles file.

   @tailwind base;
   @tailwind components;
   @tailwind utilities;

• You're ready to go!

Testing

Solibee component library was built with testing in mind. Testing is done with Jest and Solid JS Testing Library. Testing has been implemented on 100% of custom components. Currently, all tests for the custom components exist in our github.

Contributors

Marselena Sequoia

• GitHub: @marsbird

Bongi Sibanda

• GitHub: @trialnerr

Neul Seo

• GitHub: @neulseo2

Lillian Tenn

• GitHub: @tenn501

Congke Zhao

• GitHub: @CK-Zhao

License

Solibee is an open-source product licensed under the MIT License.