https://github.com/accntech/shad-ui
Avalonia-based UI Library inspired by shadcn and Suki UI Library
https://github.com/accntech/shad-ui
Last synced: 2 months ago
JSON representation
Avalonia-based UI Library inspired by shadcn and Suki UI Library
- Host: GitHub
- URL: https://github.com/accntech/shad-ui
- Owner: accntech
- License: mit
- Created: 2025-01-08T02:15:26.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T12:42:02.000Z (3 months ago)
- Last Synced: 2025-04-15T00:11:50.109Z (2 months ago)
- Language: C#
- Homepage:
- Size: 19.2 MB
- Stars: 40
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-avalonia - ShadUI - A modern, beautiful, and intuitive UI library inspired by [shadcn/ui](https://ui.shadcn.com/) and [Suki UI Library](https://kikipoulet.github.io/SukiUI/). (Libraries & Extensions / Theme & Icons)
README
# ShadUI ✨
ShadUI is an **Avalonia-based Desktop UI Library** inspired by [shadcn/ui](https://ui.shadcn.com/)
and [Suki UI Library](https://kikipoulet.github.io/SukiUI/).
Our goal is to deliver a modern, beautiful, and intuitive UI library for [Avalonia](https://avaloniaui.net/).
[](https://www.nuget.org/packages/ShadUI)
[](https://www.nuget.org/packages/ShadUI)
[](https://github.com/accntech/shad-ui/stargazers)
**Forever free and open-source.** 🚀
---
## Installation 🚀
To get started with ShadUI:
Install the [ShadUI NuGet package](https://www.nuget.org/packages/ShadUI/):
```powershell
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.
```powershell
dotnet add package ShadUI --version [version]
```
Include ShadTheme in your App.xaml:
```xml
```
> Recommended: Use the `ShadUI.Controls.Window` instead of `Avalonia.Controls.Window` to get the full ShadUI experience.
Install the [ShadUI App](https://apps.microsoft.com/detail/9N3358B0PHG4?hl=en-us&gl=PH&ocid=pdpshare) 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](https://ui.shadcn.com/)
and [Suki UI Library](https://kikipoulet.github.io/SukiUI/).
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.
---
## Acknowledgments 💖
ShadUI wouldn't be possible without the inspiration and contributions of the following projects and libraries:
- [Avalonia](https://avaloniaui.net/): A cross-platform XAML-based UI framework with a robust styling system.
- [shadcn/ui](https://ui.shadcn.com/) and [Suki UI Library](https://kikipoulet.github.io/SukiUI/): The foundation of our
design principles and control ideas.
- [Lucide Avalonia Icons](https://github.com/MarwanFr/LucideAvaloniaUI/): A collection of icons tailored for Avalonia
UI.
- [Responsive.Avalonia](https://github.com/russkyc/responsive-avalonia): A library for building responsive layouts.
- [LiveCharts](https://livecharts.dev/): A library for creating visually stunning charts.
- [MvvmToolkit](https://github.com/CommunityToolkit): A framework for implementing the MVVM pattern efficiently.
---
## Contributing 🤝
We welcome contributions to ShadUI! Before getting started, please review our [Contributing Guidelines](https://github.com/accntech/shad-ui/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/accntech/shad-ui/blob/main/CODE_OF_CONDUCT.md).
Feel free to open issues, suggest new features, or submit pull requests.
---
## License 📜
ShadUI is licensed under the **MIT License**. See the [LICENSE](https://github.com/accntech/shad-ui/blob/main/LICENSE) file for details.