README
A modern UI kit packed with 2 custom page templates
and 11 extra custom components built on top of Shards UI and Bootstrap (4.5.3).
Components Demo • Templates Demo • Documentation • Official Page
Getting Started
Currently there are only three ways of downloading Joy UI:
The distributed Joy UI assets are also available via CDN through unpkg and jsDelivr.
To install with npm:
npm install --save @therunninghub/joy-ui bootstrap
To install with yarn:
yarn add @therunninghub/joy-ui bootstrap
Dependencies
The only hard dependency is Bootstrap 4.5.3 which needs to be included in your HTML document before Joy UI.
Quick Start
If you're using a bundler like webpack, you should skip to Usage with Bundlers.
In order to take advantage of both Bootstrap and Joy UI's features you may want to use the following starter template that includes all dependencies.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS Dependencies -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
<link rel="stylesheet" href="https://unpkg.com/@therunninghub/joy-ui@latest/dist/css/joy.min.css">
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>
Built using
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Feedback
Building better products is something we are trying to get really good at. We would love to hear more about how you plan on using Joy UI and what features you consider important in similar products.
Acknowledgments
While building this project we used various free resources built and made available by some wonderful people around the world. See the ATTRIB.md file for details.