kodiui-ui
v0.0.1
Published
@kodiui/cli helps you easily drop Kodi UI's responsive layout components into your React project. Crafted with Tailwind CSS and inspired by "Every Layout CSS," these components are super versatile, and they'll adapt to your design needs in no time. Instal
Downloads
1
Maintainers
Readme
@kodiui/cli helps you easily drop Kodi UI's responsive layout components into your React project. Crafted with Tailwind CSS and inspired by "Every Layout CSS," these components are super versatile, and they'll adapt to your design needs in no time. Install, tweak, and watch your layout game level up!
Available Components 🛠
center.tsx 🎯
- Centrally aligns content both vertically and horizontally.
cluster.tsx 🍇
- Groups and spaces out items within a layout.
flex-box.tsx 🏗
- Leverages Flexbox for creating responsive and adaptable layouts.
hidden.tsx 🙈
- Provides an easy way to hide or show elements based on specific design requirements.
reel.tsx 🎞
- A horizontal scrolling component, ideal for showcasing a list of items.
sidebar.tsx 📑
- Incorporates a sidebar into your layout, perfect for additional content or navigation.
split.tsx 🧩
- Divides content into distinct sections.
stack.tsx 📚
- Vertically stacks content, ensuring a clean and organized layout.
switcher.tsx 🔀
- A flexible component that enables seamless switching between different views or content.
Getting Started 🚀
To incorporate Kodi UI's primitive components into your project, simply follow these steps:
Install the Components
Run the following command to launch the CLI and install the primitive components:
npx @kodiui/cli@latest
When prompted, select "Install Primitives".
- Configure Tailwind CSS
After installation, you'll need to integrate the spacing token into your Tailwind CSS configuration. Open your Tailwind config file and include the spacing token like so:
// tailwind.config.js
import type { Config } from "tailwindcss";
import { spacing } from "@/components/primitives/tokens/spacing";
const config: Config = {
content: [
// ... (your other content paths)
],
theme: {
// ...
extend: {
// ...
spacing: spacing,
},
},
};
export default config;
And that's it! You're now ready to harness the power of Kodi UI's primitive components in your React project. Enjoy crafting beautiful, responsive layouts with ease!