# Installation

# CDN

Installing Kickstand UI is as easy as adding a few tags to your page.

<link
    rel="stylesheet"
    href="https://unpkg.com/kickstand-ui/dist/kickstand-ui/kickstand-ui.css"
/>
<script src="https://unpkg.com/kickstand-ui/dist/kickstand-ui.js"></script>

# Package Manager

If you are using build tools or a framework, you can add it to your project as an NPM package.

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 and to take advantage of all of the built-in tooling and customization capabilities you should plan on using it in your project. You can import them into your project from kickstand-ui/src/scss/styles.scss. If not you can always use the compiled CSS located in kickstand-ui/dist/kickstand-ui/kickstand-ui.css.

# Framework Integrations

HTML5 Vuejs React Angular Ember

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