JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q37247F
  • License MIT

Vibrant Kit is a simple component library UI kit that gives you the building blocks you need to build your React applications.

Package Exports

  • vibrant-kit
  • vibrant-kit/build/index.esm.js
  • vibrant-kit/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vibrant-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Contributors Forks Stargazers Issues MIT License LinkedIn


Vibrant Kit

Vibrant Kit

Vibrant Kit is a simple component library UI kit that gives you the building blocks you need to build your React applications.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

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

(back to top)

This project was built using:

Built With

  • React
  • CSS
  • Rollup
  • Storybook
  • Typescript
  • JavaScript
  • Testing Library

(back to top)

Getting Started

Installation

npm install --save vibrant-kit

(back to top)

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).

(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

(back to top)

License

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

(back to top)

Contact

Udendu Abasili - udbasili@yahoo.com

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

(back to top)

Acknowledgments

(back to top)