shadlc
v1.0.18
Published
A fully customizable UI library built with React and Tailwind CSS.
Maintainers
Readme
ShadLC - A Modern UI Library for React
ShadLC is a lightweight and customizable UI component library built for React with Tailwind CSS. It provides reusable and stylish components to speed up your development process while keeping your UI clean and modern.
✨ Features
- 📌 Pre-styled & Customizable – Components are designed with Tailwind CSS and can be customized easily.
- ⚡ Lightweight & Fast – Optimized for performance and smooth user experience.
- 🏗 Reusable Components – Copy-paste-ready components for quick integration.
- 🎨 Theming Support – Modify styles to match your brand identity.
🚀 Installation
To use ShadLC in your project, install it via npm:
npm install shadlcor with Yarn:
yarn add shadlc✅ Tailwind CSS Configuration (For Tailwind 3 & 4)
Make sure you have Tailwind CSS installed in your project. If not, install it:
npm install tailwindcss postcss autoprefixer
npx tailwindcss initThen, configure your tailwind.config.js to include the library’s styles:
Tailwind CSS v3 Configuration:
module.exports = {
content: [
"./node_modules/shadlc/**/*.js",
"./src/**/*.{js,ts,jsx,tsx}"
],
theme: {
extend: {},
},
plugins: [],
};Tailwind CSS v4 Configuration:
export default {
content: [
"./node_modules/shadlc/**/*.js",
"./src/**/*.{js,ts,jsx,tsx}"
],
theme: {
extend: {},
},
plugins: [],
};✅ Import ShadLC Styles
After installing the package, import the styles in your main entry file:
import "shadlc/style.css";✅ To use client components
Use the use client on the top if you are using nextjs.
"use client";📚 Components Usage Template
Code Clipboard Component
Easily copy code snippets with a click of a button.
🔹 Usage
import { CodeClipboard } from "shadlc";
import "shadlc/style.css";
const codeSnippet = `const hello = "Hello, World!";`;
const App = () => {
return (
<div className="p-6">
<h1 className="text-xl font-bold mb-4">Copy Code Example</h1>
<CodeClipboard code={codeSnippet} />
</div>
);
};🔹 Features
- 📋 Click-to-copy button with a clipboard icon
- ✅ Shows "Copied!" confirmation message
- 🎨 Customizable styles & animations
🛠 Development & Contribution
If you want to contribute or customize the library:
Clone the repository:
git clone https://github.com/Taha-Asif-313/shadlc.git cd shadlcInstall dependencies:
npm installBuild the package for production:
npm run build
📜 License
This project is licensed under the MIT License – feel free to use and modify it as needed.
💬 Need Help?
If you have any questions or need support, feel free to open an issue or reach out via email.
