/kutty

Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.

Primary LanguageJavaScriptMIT LicenseMIT

Kutty

Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.

This plugin requires Tailwind CSS 1.6 or later.

Installation

npm i kutty --save

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

Usage

For CSS

Require the installed plugin directly to your Tailwind config:

// tailwind.config.js
plugins: [require("kutty")],

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 For generating production docs files

Components

  • Alert
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Card
  • Collapse
  • Dialog
  • Drawer
  • Dropdown
  • Forms
  • List
  • Pagination
  • Sidebar
  • Skeleton
  • Spinner
  • Tabs
  • Typography
  • Toasts
  • Tooltips