ShadUI 0.1.4

ShadUI ✨

ShadUI (shad·UI /ˈʃæd juː aɪ/) is an Avalonia-based Desktop UI Library inspired by shadcn/ui and Suki UI Library.
Our goal is to deliver a modern, beautiful, and intuitive UI library for Avalonia.

Forever free and open-source. 🚀

Installation 🚀

To get started with ShadUI:

Install the ShadUI NuGet package:

dotnet add package ShadUI

Note: The command above will install the latest version automatically. You can also specify a version if you want to install a specific version or install a preview version.

dotnet add package ShadUI --version [version]

Include ShadTheme in your App.xaml:

<Application
    xmlns:themes="clr-namespace:ShadUI.Themes;assembly=ShadUI">

    

    <Application.Styles>
        <themes:ShadTheme />
        
    </Application.Styles>
</Application>

Recommended: Use the ShadUI.Controls.Window instead of Avalonia.Controls.Window to get the full ShadUI experience.

<img src="https://learn.microsoft.com/en-us/windows/apps/images/new-badge-dark.png" alt="App Screenshot" width="200"/>

Download ShadUI App from Microsoft Store for examples of how to use ShadUI controls.

Features 🌟

🎨 Theme

ShadUI provides a default theme out of the box, allowing you to get started quickly with a professional look and feel.

🛠️ Controls

ShadUI includes a growing set of essential UI controls, inspired by shadcn/ui and Suki UI Library.
We are actively working to expand the library with additional controls and advanced features.

💬 Dialogs

ShadUI offers a simple yet powerful system for dialogs, enabling you to create interactive and responsive user experiences effortlessly.

🔔 Toasts

Deliver quick, non-intrusive messages with ShadUI's built-in toast notifications system, designed for clarity and ease of use.

🧩 Composable Sidebar

ShadUI provides a flexible and composable sidebar system that allows you to create dynamic navigation experiences with ease.

Acknowledgments 💖

ShadUI wouldn't be possible without the inspiration and contributions of the following projects and libraries:

• Avalonia: A cross-platform XAML-based UI framework with a robust styling system.
• shadcn/ui and Suki UI Library: The foundation of our design principles and control ideas.
• Lucide Icons: A beautifully curated collection of icons that provides consistent, scalable vector icons for modern applications.
• Responsive.Avalonia: A library for building responsive layouts.
• LiveCharts: A library for creating visually stunning charts.
• MvvmToolkit: A framework for implementing the MVVM pattern efficiently.
• Jab: A fast compile-time dependency injection container without runtime dependencies.
• AvaloniaEdit.TextMate: A text editor component with syntax highlighting support for Avalonia applications.

Thank you to all the amazing contributors who have helped make ShadUI what it is today!

<a href="https://github.com/accntech/shad-ui/graphs/contributors"> <img width="150" src="https://contrib.rocks/image?repo=accntech/shad-ui" /> </a>

Special Thanks 🙏

We extend our heartfelt gratitude to these amazing platforms and tools that make ShadUI possible:

<div align="center"> <img src="https://github.com/dotnet/brand/blob/main/logo/dotnet-logo.png?raw=true" alt=".NET" height="48"/>      <img height="48px" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains">      <img height="48px" src="https://avatars.githubusercontent.com/u/139895814?s=48&v=4" alt="shadcn/ui logo"> </div>

• .NET: For providing the powerful C# language and cross-platform runtime that powers our applications
• JetBrains: For providing free use of <a href="https://www.jetbrains.com/rider">Rider</a>, the IDE used in the development
• shadcn/ui: For the beautiful design system and components that inspired ShadUI's visual foundation

Contributing 🤝

We welcome contributions to ShadUI! Before getting started, please review our Contributing Guidelines and Code of Conduct.
Feel free to open issues, suggest new features, or submit pull requests.

License 📜

ShadUI is licensed under the MIT License. See the LICENSE file for details.