https://github.com/rossrobino/uico

UI components for TailwindCSS projects
https://github.com/rossrobino/uico

components css tailwindcss

Last synced: about 2 months ago
JSON representation

UI components for TailwindCSS projects

• Host: GitHub
• URL: https://github.com/rossrobino/uico
• Owner: rossrobino
• License: mit
• Created: 2023-08-30T18:50:52.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-18T17:50:00.000Z (5 months ago)
• Last Synced: 2024-07-20T14:44:36.097Z (2 months ago)
• Topics: components, css, tailwindcss
• Language: TypeScript
• Homepage: https://uico.robino.dev
• Size: 791 KB
• Stars: 20
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Read Me

**uico** is a minimal TailwindCSS plugin that provides CSS components, system font stack utilities, and a drop in oklch color palette. **uico** works wherever Tailwind does.

The advantage of using a plugin instead of writing custom CSS is that the Tailwind compiler will remove any classes that are not used in the project, ensuring only what is used gets added to the final output.

## Install

```bash

npm i -D uico

```

## Setup

### Config

Import and add the plugin to your `tailwind.config`, optionally, pass in an optional configuration object. Be sure to upgrade Tailwind to the latest version for type compatibility.

```ts

// tailwind.config.ts

import type { Config } from "tailwindcss";

import { uico } from "uico"; // import

export default {

	// ...

	plugins: [

		uico({

			// optional configuration

			// these are the default values

			components: true,

			fonts: true,

			colorFunction: false,

			colorPalette: "hex",

		}),

	],

} satisfies Config;

```