Skip to content

break-stuff/kickstand-ui

master
Switch branches/tags
Code
This branch is up to date with kickstand-ui/kickstand-ui:master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

kickstand logo

Kickstand UI

The Design System You Can Use Everywhere

Kickstand UI is a Design system and pattern library built with Web Components, so you can use them anywhere without having to worry about framework compatibility (we have worked hard to make sure of that)!

Check out the Docs →

Installation

CDN

<!-- global styles and utility classes -->
<link rel="stylesheet" href="https://unpkg.com/kickstand-ui/dist/kickstand-ui/kickstand-ui.css" />

<!-- scripts for browsers that support ES modules -->
<script type="module" src="https://unpkg.com/kickstand-ui/dist/kickstand-ui/kickstand-ui.esm.js"></script>
<!-- scripts for browsers that do not support ES modules (legacy browsers) -->
<script nomodule src="https://unpkg.com/kickstand-ui/dist/kickstand-ui/kickstand-ui.js"></script>

(For the best user experience, be sure to include both script tags.)

Package Manager

npm install --save kickstand-ui

# or

yarn add kickstand-ui

Add To Your Project

import { applyPolyfills, defineCustomElements } from 'kickstand-ui/loader';

// Apply the polyfills and bind the custom elements to the window object
applyPolyfills().then(() => {
    defineCustomElements();
});

Styles

Kickstand UI was written using SASS. Using SASS is not required to use and customize Kickstand UI for your needs, but we have created some great SASS tools to really accelerate the development process. You can import them into your project from kickstand-ui/src/scss/styles.scss.

If you are planning on using the compiled CSS, you can find it at kickstand-ui/dist/kickstand-ui/kickstand-ui.css.

Browser Support

Kickstand UI's components are built using standards-based web components. Browser support has greatly improved over the years. For features that are not fully supported, polyfills have been added (which will be included as-needed) to provide a great experience no matter what browser you are using.

Supported browsers include:

  • Chrome
  • Chromium-based browsers (this includes browsers like Brave, the new Microsoft Edge, and Vivaldi)
  • Firefox
  • Safari
  • Opera
  • Microsoft Edge (legacy)
  • Internet Explorer 11.

Framework Integrations

Kickstand UI is built with native web components which makes it framework agnostic! You can implement it in any of your projects regardless of the framework you are using (add to your project).

Once you have installed Kickstand UI, check out the documentation on how to implement it into your favorite framework (or none at all!):

About

The customizable design system you can use anywhere

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 67.8%
  • SCSS 29.2%
  • HTML 2.2%
  • JavaScript 0.8%