Huskui.Avalonia 1.1.3

Huskui.Avalonia

<div align="center">

A modern, elegant UI component library for Avalonia UI, designed for beautiful cross-platform desktop applications.

Inspired by ParkUI and built with the Radix Colors palette.

</div>

Compatibility

• NuGet package: Huskui.Avalonia
• Target frameworks: net8.0, net10.0
• Avalonia requirement: 12.0.x
• License: MIT

Features

• Rich Component Library: Includes a wide range of UI components like AppWindow, Card, InfoBar, Tag, IconLabel, and more
• Consistent Design Language: All components follow a cohesive design system with shared colors, animations, and behaviors
• Theming Support: Built-in support for light and dark themes
• Fluent Icons Integration: Uses FluentIcons.Avalonia for consistent iconography
• Modern UI Elements: Includes modern UI patterns like overlays, notifications, and dialogs
• Customizable: Easily customize the appearance of components through XAML styles and themes

Components

Huskui.Avalonia includes the following components:

• AppWindow: Enhanced window with a built-in AppSurface for overlays, floating panels, and notifications
• Card: Container for grouping related content with consistent styling
• InfoBar: Informational message bars with different severity levels
• Tag: Compact labels for categorization and metadata
• IconLabel: Combined icon and text label with FluentIcons integration
• Frame: Navigation container with transition animations
• HighlightBlock: Text highlighting for code snippets and keyboard shortcuts
• AppSurface: Root container for the entire overlay and floating-layer system
• OverlayHost and Dialogs/Modals/Sidebars/Toasts: Shared host for modal overlay controls
• GrowlHost and GrowlItem: Dedicated non-modal host for transient notification feedback
• DrawerHost and Drawer: Dedicated non-modal host for draggable and resizable drawer panels
• SkeletonContainer: Loading placeholder for content
• BusyContainer: Container with loading state management
• LazyContainer: Component for deferred loading of content
• And many more...

Extensions

Huskui.Avalonia offers optional extension libraries that extend the core functionality:

Gallery

Explore all components and their features in the interactive Gallery application included in this repository. The Gallery provides live examples, interactive controls, and comprehensive documentation for each component.

To run the Gallery:

dotnet run --project src/Huskui.Gallery

Documentation

This project changes frequently, and with limited maintainer bandwidth, we are currently unable to create and continuously maintain full documentation for every control.

If you need help understanding or using specific controls, AI-assisted development can help you get productive faster.

AI-assisted workflow

1. Download or clone the source code.

2. Use one of the following approaches:

   • Ask Claude:

     Study this repository and explain the difference between Sidebar and Drawer controls, and how to use them.
     

Helpful prompt ideas:

• Explain what this control is for and when to use it.
• Compare two similar controls and highlight their differences.
• Show a minimal usage example for a specific control.
• Trace which themes, styles, and supporting classes a control depends on.
• Summarize the public API of a control from the source code.

Getting Started

Prerequisites

• .NET 8.0 or 10.0
• Avalonia UI 12.0.x

Installation

dotnet add package Huskui.Avalonia

Basic Usage

1. Add the Huskui.Avalonia namespace to your XAML:

<Application xmlns="https://github.com/avaloniaui"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:husk="https://github.com/d3ara1n/Huskui.Avalonia"
             x:Class="YourApp.App">
    <Application.Styles>
        <FluentTheme />
        <husk:HuskuiTheme Accent="Lime" />

        
        <StyleINclude Source="avares://Huskui.Avalonia/Themes/Addons.NoAutoScrollToSelectedItem.axaml" />
        <StyleINclude Source="avares://Huskui.Avalonia/Themes/Addons.InlineUIContainerAlignment.axaml" />
    </Application.Styles>
</Application>

1. Use Huskui components in your views:

<husk:AppWindow xmlns="https://github.com/avaloniaui"
                xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                xmlns:husk="https://github.com/d3ara1n/Huskui.Avalonia"
                x:Class="YourApp.MainWindow"
                Title="Your App">
    <Grid RowDefinitions="Auto,*" Margin="24">
        <husk:Card Grid.Row="0" Margin="0,0,0,12">
            <husk:InfoBar Header="Welcome" Content="This is a sample application using Huskui.Avalonia" />
        </husk:Card>

        <StackPanel Grid.Row="1" Spacing="12">
            <husk:IconLabel Icon="Home" Text="Home" />

            <Button Content="Standard Button" />
            <Button Classes="Primary" Content="Primary Button" />
            <Button Classes="Success" Content="Success Button" />

            <husk:Tag Content="Sample Tag" />
        </StackPanel>
    </Grid>
</husk:AppWindow>

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Setup

1. Clone the repository
2. Restore tools: dotnet tool restore
3. Open in VS Code and install recommended extensions when prompted

XAML files are auto-formatted on save via XAML Styler.

Please ensure your XAML is formatted before submitting a PR.

License

This project is licensed under the MIT License.