UNPKG

@richaadgigi/stylexui

Version:

Build responsive, beautiful interfaces faster than ever with utility-first classes and smart defaults. No bloat. No fuss. Just results.

177 lines (113 loc) β€’ 7.14 kB
# StyleXui A lightweight and modern CSS framework designed to streamline your development process effortlessly. ## πŸš€ Overview StyleXui, also known as **Style You**, is a CSS framework built to enhance your workflow with pre-designed components and utility classes. Whether you're an experienced developer or just starting out, StyleXui helps you build stunning, responsive UIs with ease. Created by **Richard Gigi**, co-founder of **Xnyder**, StyleXui was developed to tackle common design inefficiencies in modern web development. Dive in and see how StyleXui can bring your projects to life! 🎨✨ --- ## 🌟 Features βœ” **Fully Responsive** – Built with a mobile-first approach, ensuring flawless adaptability across all screen sizes. Whether on a phone, tablet, or desktop, your design remains pixel-perfect and seamless. βœ” **Pre-Built Components** – Speed up development with a library of ready-to-use elements like buttons, modals, and navigation bars. No need to build from scratchβ€”just plug, customize, and launch. βœ” **Effortless Customization** – A utility-first framework that lets you style elements with ease, keeping your code clean and efficient. Define your own colors, spacing, and unitsβ€”your design, your way. βœ” **Accessibility-First** – Designed with inclusivity in mind, ensuring smooth navigation and interaction for all users, regardless of ability. βœ” **Seamless Light & Dark Mode** – Instantly switch between bright and dark themes for a comfortable viewing experience, day or night. βœ” **Comprehensive Documentation** – A well-structured, beginner-friendly guide to help you get started effortlessly and make the most outΒ ofΒ StyleXui. βœ” **JavaScript Enhancements** – Optional JavaScript for interactive components with smooth animations and behaviors. --- ## πŸ“¦ Installation ### 1️⃣ Via CDN *(Quickest Setup)* Add the following `<link>` tag to your HTML file: ```html <!-- CSS --> <link rel="stylesheet" href="https://cdn.stylexui.com/@v1.1.0/css/xui.css" /> <!-- Optional JavaScript (for interactive components) --> <script src="https://cdn.stylexui.com/@v1.1.0/js/xui.js" defer></script> ``` βœ… Best for: Prototyping, static HTML projects, minimal dependencies. ### 2️⃣ NPM/Yarn *(For Modern Frameworks)* **Using NPM:** ```sh npm install @richaadgigi/stylexui ``` **Using Yarn:** ```sh yarn add @richaadgigi/stylexui ``` Then, import it in your project: ```js import '@richaadgigi/stylexui/css/xui.min.css'; import { apply } from '@richaadgigi/stylexui'; apply(); ``` βœ… Best for: React, Vue, Angular, scalable projects, and version control. ### 3️⃣ Manual Download *(Offline or Custom Hosting)* 1. Download the latest version from the [official website](https://stylexui.com) or the [zip file](https://github.com/richaadgigi/stylexui/archive/refs/tags/v1.1.0.zip). 2. Extract the files and link the CSS in your HTML file: ```html <!-- CSS --> <link rel="stylesheet" href="path/to/xui.css" /> <!-- Optional JavaScript (for interactive components) --> <script src="path/to/xui.js" defer></script> ``` βœ… Best for: Legacy systems, static projects, or custom hosting. --- ## πŸ”§ Getting Started ### Basic HTML Boilerplate Copy and paste the following template to start using StyleXui: ```html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>My StyleXui Project</title> <link rel="stylesheet" href="path/to/xui.css"> </head> <body> <div class="xui-container"> <h1>Welcome to StyleXui</h1> <p>Build modern, responsive, and accessible UIs with ease.</p> <button class="xui-btn xui-btn-primary">Get Started</button> </div> <!-- Optional StyleXui JS (for interactive components) --> <script src="path/to/xui.js"></script> </body> </html> ``` Visit our documentation to [learn more](https://doc.clickup.com/9012486388/p/h/8cjz87m-2112/8989912e92c935b/8cjz87m-2112). --- ## πŸ“œ Release Notes ### πŸ”Ή Version 1.1.0 ⚑️ Massive Package Size Reduction: The core font folder (approx. 8MB) has been removed from the distribution. StyleXui now defaults to system fonts, allowing developers to import and optimize custom fonts themselves, resulting in a significantly faster download and build process. πŸ–ΌοΈ Asset Cleanup: Included assets and images have been optimized, further reducing the package size. πŸ“¦ New Flexbox Utility Scale (xui-flex-*): Introduced a powerful, simplified scale for the CSS flex shorthand, replacing the need to use separate grow/shrink classes for common use cases. πŸ“ Comprehensive Flex Basis Utilities: Added individual utilities for the flex-basis property, giving users full control over the initial size of flex items. πŸ“ Modern Gap Utilities (Grid & Flex): Replaced the deprecated grid-gap with the unified gap property, which now works for both Flexbox and CSS Grid layouts. 🌎 Enhanced Container Logic: The core `.xui-container` class has been updated to include max-width at responsive breakpoints and is now centered, implementing the modern standard for fluid, readable content on all screen sizes. ### πŸ”Ή Version 1.0.1 βœ… Fixed: Ripple effect animation now works as expected for better visual feedback. 🧼 Updated: Dashboard redesigned with a cleaner and neater UI for improved clarity and user experience. 🧩 New Utility: Introduced "xui-bdr-rad-none" to easily apply "border-radius: none". πŸ“‚ Dashboard Navigation: Now supports dropdowns for subpages, making multi-level navigation seamless. πŸš€ Improved Styling Logic: Dynamic CSS now uses !important to ensure proper style overrides. ### πŸ”Ή Version 1.0.0 (Beta) βœ… Initial release of StyleXui! πŸš€ βœ… Includes core CSS utilities and components βœ… Optional JavaScript for interactive elements βœ… Comprehensive documentation --- ## 🌍 Contribution We welcome contributions! Feel free to submit issues or pull requests to help improve StyleXui. ## πŸ“œ License StyleXui is open-source and distributed under the **MIT License**, ensuring flexibility for both personal and commercial use. ### πŸ”‘ Key Terms of MIT License - βœ… **Permitted Uses:** Personal, commercial, and enterprise applications. Modification, distribution, and sublicensing allowed. - ❌ **Restrictions:** No warranty or liability for damages. Must retain copyright notices. ### πŸ“Œ Third-Party Dependencies StyleXui utilizes **normalize.css v3.0.1** to ensure consistent styling across browsers. Normalize.css is also licensed under the MIT License. For full licensing details, refer to the [MIT License documentation](https://opensource.org/licenses/MIT). --- ## πŸ”— More Information πŸ“Œ **Official Website:** [StyleXui](https://stylexui.com) πŸ“Œ **Support & Issues:** [GitHub Issues](https://github.com/richaadgigi/stylexui/issues) ✨ **Enjoy building with StyleXui!** πŸŽ¨πŸš€