About the Project

This is a simple UI Kit that gives you general components you can use for your Javascript Project with the main focus on React

This project was built using:

• Rollup
• TypeScript
• CSS
• Storybook to help you create and show off your components
• Tested with Jest and React Testing Library

Built With

Getting Started

Installation

npm install --save vibrant-kit

Usage

Stylesheet

First, you'll need to import the index.css CSS file distributed by the package. This should be done at the root of your project (in index.js or App.tsx of your React app) and will look like this:

import 'vibrant-kit/build/index.css';

...

Components

Usage of components for the library is achieved by:

import { Button, SlideShow } from 'vibrant-kit';

const slideShowData = [
 {
  title: 'Slide 1',
  description: 'Description Slide 1',
  imageUrl: 'https://cdn.pixabay.com/photo/2016/12/27/22/31/converse-1935028_1280.jpg',
 },
 {
  title: 'Slide 2',
  description: 'Description Slide 2',
  imageUrl: 'https://cdn.pixabay.com/photo/2014/07/31/23/42/legs-407196_1280.jpg',
 },
 {
  title: 'Slide 3',
  description: 'Description Slide 3',
  imageUrl: 'https://cdn.pixabay.com/photo/2014/09/03/20/15/shoes-434918_1280.jpg',
 },
];

<SlideShow slideShowData={slideShowData} />
<Button size="lg" variant="primary" type="button">
  This is me
</Button>

Roadmap

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

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.txt for more information.

Contact

Udendu Abasili - [email protected]

Project Link: https://github.com/udabasili/vibrant-kit

Acknowledgments