JSPM

  • Created
  • Published
  • Downloads 101
  • Score
    100M100P100Q89740F
  • License MIT

Kutty is a set of accessible and reusable components for building web applications.

Package Exports

  • kutty

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 (kutty) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Kutty

Kutty is a set of accessible and reusable components for building web applications. It uses Tailwind classes, which is an utility based CSS framework, for styling the components.

Installation

npm i kutty --save

Tailwind CSS is not available in this package. Learn how to install tailwind here.

Usage

For CSS

For importing the whole package:

@import "tailwindcss/base";
@import "tailwindcss/components";
/* Add Kutty here */
@import "kutty";
@import "tailwindcss/utilities";

Or for importing any single component:

@import "tailwindcss/base";
@import "tailwindcss/components";
/* Add Kutty here */
@import "kutty/src/button.css";
@import "tailwindcss/utilities";

For JS

Place the following script tag before the closing body tag:

<script src="https://cdn.jsdelivr.net/npm/kutty@latest/dist/kutty.min.js"></script>

Development

You need Hugo to run the dev server. If you have Homebrew you can do the following:

brew install hugo

Check this Hugo installation page for installing on other systems.

Then clone the repo, install dependencies, and start the server locally.

git clone https://github.com/praveenjuge/kutty.git
cd kutty
npm i
npm start

Open http://localhost:1313 in your browser.

Scripts Description
npm start Starts a local Hugo server and Tailwind Watcher
npm run production && rollup -c && hugo For generating production docs files

Components

  • Alert
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Card
  • Dialog
  • Dropdown
  • Forms
  • List
  • Pagination
  • Tabs
  • Collapse
  • Loading
  • Toasts
  • Tooltips