coden-ui
v0.0.1
Published
A UI component library for React with Tailwind CSS support
Downloads
14
Maintainers
Keywords
Readme
const readmeContent = `
Coden UI Library
Welcome to Coden UI Library—a comprehensive and customizable UI component library for React, designed to accelerate your web development process with ease and elegance.
Overview
Coden UI is a modern React component library that provides a rich set of pre-designed components for building sophisticated and responsive user interfaces. Our library is styled using Tailwind CSS, ensuring that your application not only looks great but also remains highly customizable.
Key Features
- Predefined Components: Import a variety of ready-to-use components tailored for web development. Whether you need buttons, inputs, alerts, or more, Coden UI has got you covered.
- Fully Responsive: All components are designed to be fully responsive, ensuring a seamless experience across different devices and screen sizes.
- Tailwind CSS Styling: Leveraging Tailwind CSS for styling, our components offer a clean and utility-first approach to design, making it easy to adapt and customize to your needs.
- Built-In Variations: Each component comes with multiple built-in variations, allowing you to easily switch styles and configurations without additional effort.
- Classnames Integration: Utilizing the
classnames
library, our components offer dynamic class management, making it easier to apply conditional styles and ensure your UI responds to state changes smoothly.
Getting Started
To start using Coden UI in your React project, follow these steps:
Install the Package:
npm install coden-ui
Import Components:
Import the components you need from the library:
import { Button, Alert, Input } from "coden-ui";
Use Components:
Utilize the components in your application:
<Button variant="primary">Click Me</Button> <Alert type="success">Operation Successful!</Alert> <Input placeholder="Enter your text here" />
Integrating Coden UI with Tailwind CSS
To integrate coden-ui
styles with Tailwind CSS and ensure that the necessary CSS classes are not purged, follow these steps:
Install
coden-ui
:Ensure that you have
coden-ui
installed in your project:npm install coden-ui
Update Tailwind CSS Configuration:
In your
tailwind.config.ts
file, import thecoden-ui
configuration and add its styles to the safelist. Here’s how you can do it:Example Configuration (
tailwind.config.ts
)import type { Config } from 'tailwindcss'; const config: Config = { content: [ './src/**/*.{js,ts,jsx,tsx}', // Adjust paths according to your project structure 'node_modules/coden-ui/**/*.{js,ts,jsx,tsx,mdx}', // Add this file to avoid purging of styles, we are working to give better alternative method for this. Thank you for your co-operation. './public/index.html', ], theme: { extend: {}, }, plugins: [], }; export default config;
Component Documentation
Explore detailed documentation for each component by following the links below:
For a comprehensive overview of all components and additional details, visit the Documentation Index.
Contributing
We’re excited to announce that the repository will soon be available for public contributions! We welcome you to participate in enhancing and extending Coden UI. Keep an eye on the repository for updates on how you can get involved. For more details on contributing, please refer to our contributing guidelines.
Thank You
Thank you for choosing Coden UI! We hope you find our library useful and enjoyable.We are coming with more features soon.
License
Coden UI is released under the MIT License. See the LICENSE file for more details.