Projektanker.Icons.Avalonia 9.6.0

dotnet add package Projektanker.Icons.Avalonia --version 9.6.0                
NuGet\Install-Package Projektanker.Icons.Avalonia -Version 9.6.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Projektanker.Icons.Avalonia" Version="9.6.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Projektanker.Icons.Avalonia --version 9.6.0                
#r "nuget: Projektanker.Icons.Avalonia, 9.6.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Projektanker.Icons.Avalonia as a Cake Addin
#addin nuget:?package=Projektanker.Icons.Avalonia&version=9.6.0

// Install Projektanker.Icons.Avalonia as a Cake Tool
#tool nuget:?package=Projektanker.Icons.Avalonia&version=9.6.0                

Icons.Avalonia

A library to easily display icons in an Avalonia App.

🚀 Push 🔄 Sync Fontawesome 🔄 Sync Material Design

NuGet

Name Description Version
Projektanker.Icons.Avalonia Core library Nuget
Projektanker.Icons.Avalonia.FontAwesome Font Awesome 6 Free Nuget
Projektanker.Icons.Avalonia.MaterialDesign Material Design Icons Nuget

Icon providers

Name Prefix Example
FontAwesome 6 fa fa-github
MaterialDesign mdi mdi-github

Usage

A full example is available in the Demo project.

1. Register icon providers on app start up

Register the icon provider(s) with the IconProvider.Current.

class Program
{
    // Initialization code. Don't use any Avalonia, third-party APIs or any
    // SynchronizationContext-reliant code before AppMain is called: things aren't initialized
    // yet and stuff might break.
    public static void Main(string[] args)
    {
        BuildAvaloniaApp()
            .StartWithClassicDesktopLifetime(args);
    }

    // Avalonia configuration, don't remove; also used by visual designer.
    public static AppBuilder BuildAvaloniaApp()
    {
        IconProvider.Current
            .Register<FontAwesomeIconProvider>()
            .Register<MaterialDesignIconProvider>();

        return AppBuilder.Configure<App>()
            .UsePlatformDetect()
            .LogToTrace();
    }
}

2. Add xml namespace

Add xmlns:i="https://github.com/projektanker/icons.avalonia" to your view.

3. Use the icon

Standalone

<i:Icon Value="fa-brands fa-anchor" />

Attached to ContentControl (e.g. Button)

<Button i:Attached.Icon="fa-brands fa-anchor" />

Attached to MenuItem

<MenuItem Header="About" i:MenuItem.Icon="fa-solid fa-circle-info" />

Custom icon size

<i:Icon Value="fa-brands fa-anchor" FontSize="24" />

Animated

<i:Icon Value="fa-spinner" Animation="Pulse" />
<i:Icon Value="fa-sync" Animation="Spin" />

As an Image source

<Image>
  <Image.Source>
    <i:IconImage Value="fa-brands fa-anchor" Brush="(defaults to black)" />
  </Image.Source>
</Image>

Done

Screenshot

Implement your own Icon Provider

Just implement the IIconProvider interface:

namespace Projektanker.Icons.Avalonia
{
    /// <summary>
    /// Represents an icon reader.
    /// </summary>
    public interface IIconReader
    {
        /// <summary>
        /// Gets the model of the requested icon.
        /// </summary>
        /// <param name="value">The value specifying the icon to return it's model from.</param>
        /// <returns>The model of the icon.</returns>
        /// <exception cref="System.Collections.Generic.KeyNotFoundException">
        /// The icon associated with the specified <paramref name="value"/> does not exists.
        /// </exception>
        IconModel GetIcon(string value);
    }

    /// <summary>
    /// Represents an icon provider.
    /// </summary>
    public interface IIconProvider : IIconReader
    {
        /// <summary>
        /// Gets the prefix of the <see cref="IIconProvider"/>.
        /// </summary>
        string Prefix { get; }
    }
}

and register it with the IIconProviderContainer:

IconProvider.Current.Register<MyCustomIconProvider>()

or

IIconProvider provider = new MyCustomIconProvider(/* custom ctor arguments */);
IconProvider.Current.Register(provider);

The IIconProvider.Prefix property has to be unique within all registered providers. It is used to select the right provider. E.g. FontAwesomeIconProvider's prefix is fa.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Projektanker.Icons.Avalonia:

Package Downloads
Projektanker.Icons.Avalonia.FontAwesome

A library to easily display FontAwesome icons in an Avalonia App.

Projektanker.Icons.Avalonia.MaterialDesign

A library to easily display Material Design icons in an Avalonia App.

MenuFactory

Simple Avalonia library to help manage the application menu

GitHub repositories (11)

Showing the top 5 popular GitHub repositories that depend on Projektanker.Icons.Avalonia:

Repository Stars
GreemDev/Ryujinx
Nintendo Switch emulator written in C#, originally created by gdkchan.
sn4k3/UVtools
MSLA/DLP, file analysis, calibration, repair, conversion and manipulation
aloneguid/parquet-dotnet
Fully managed Apache Parquet implementation
fifty-six/Scarab
An installer for Hollow Knight mods written in Avalonia.
BAndysc/WoWDatabaseEditor
Integrated development environment (IDE), an editor for Smart Scripts (SAI/smart_scripts) for TrinityCore based servers. Cmangos support work in progress. Featuring a 3D view built with OpenGL and custom ECS framework
Version Downloads Last updated
9.6.0 143 12/22/2024
9.5.0 2,574 11/24/2024
9.4.3 1,833 11/18/2024
9.4.2 177 11/18/2024
9.4.1 7,575 10/4/2024
9.4.0 31,077 7/21/2024
9.3.0 28,168 4/7/2024
9.2.0 1,055 3/29/2024
9.1.2 6,577 3/12/2024
9.1.1 6,346 2/22/2024
9.0.1 11,152 12/8/2023
9.0.0 675 12/6/2023
8.4.0 2,380 12/6/2023
8.3.0 9,502 10/11/2023
8.2.0 4,893 8/6/2023
8.1.0 1,078 7/26/2023
8.0.0 1,274 7/17/2023
7.0.1 1,249 7/16/2023
7.0.0 689 7/16/2023
6.6.0 1,841 7/10/2023
6.6.0-rc1.1 5,946 6/7/2023
6.6.0-preview6 1,053 4/26/2023
6.5.0-preview6 1,551 3/24/2023
6.5.0-preview5 1,210 2/28/2023
6.4.0-preview5 775 2/4/2023
6.3.0-preview4 1,823 12/12/2022
6.2.0-preview1 793 9/21/2022
6.1.0-preview1 573 8/29/2022
6.0.0-preview1 595 8/24/2022
5.13.0 4,564 4/26/2023
5.12.0 1,497 4/2/2023
5.11.0 1,075 3/26/2023
5.10.0 1,520 2/28/2023
5.9.0 1,838 2/12/2023
5.8.0 2,275 12/12/2022
5.7.0 1,058 12/12/2022
5.6.0 3,297 11/20/2022
5.5.0 12,556 9/4/2022
5.4.0 1,437 8/29/2022
5.3.0 2,621 7/31/2022
5.2.0 1,701 7/24/2022
5.1.0 2,987 7/3/2022
5.0.2 2,710 5/27/2022
5.0.1 1,603 5/23/2022
5.0.0 1,387 5/23/2022
4.5.0 1,351 5/22/2022
4.4.0 3,249 4/3/2022
4.3.0 1,518 3/27/2022
4.2.1 1,685 3/16/2022
4.2.0 1,427 3/14/2022
4.1.0 1,673 3/9/2022
4.0.1 1,449 3/8/2022
4.0.0 1,484 3/7/2022
3.7.1 2,674 12/15/2021
3.7.0 2,668 11/20/2021
3.5.0 1,184 11/12/2021
3.4.1 1,570 11/8/2021
3.4.0 1,314 11/8/2021
3.2.0 1,557 10/17/2021
3.1.4 1,074 10/14/2021
3.1.2 2,301 8/13/2021
3.1.1 1,046 8/11/2021
3.1.0 1,872 3/22/2021
3.1.0-pre 270 3/22/2021
3.0.0 983 10/29/2020 3.0.0 is deprecated.
3.0.0-pre 831 10/29/2020
2.0.2 1,218 8/12/2020
2.0.1 1,213 7/27/2020
2.0.0 1,138 7/27/2020
1.0.0 1,181 7/27/2020