Projektanker.Icons.Avalonia.FontAwesome 6.2.0-preview1

This is a prerelease version of Projektanker.Icons.Avalonia.FontAwesome.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Projektanker.Icons.Avalonia.FontAwesome --version 6.2.0-preview1                
NuGet\Install-Package Projektanker.Icons.Avalonia.FontAwesome -Version 6.2.0-preview1                
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.FontAwesome" Version="6.2.0-preview1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Projektanker.Icons.Avalonia.FontAwesome --version 6.2.0-preview1                
#r "nuget: Projektanker.Icons.Avalonia.FontAwesome, 6.2.0-preview1"                
#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.FontAwesome as a Cake Addin
#addin nuget:?package=Projektanker.Icons.Avalonia.FontAwesome&version=6.2.0-preview1&prerelease

// Install Projektanker.Icons.Avalonia.FontAwesome as a Cake Tool
#tool nuget:?package=Projektanker.Icons.Avalonia.FontAwesome&version=6.2.0-preview1&prerelease                

Icons.Avalonia

A library to easily display icons in an Avalonia App.

CI-CD

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 directory.

1. Register icon providers on app start up

Register the icon provider(s) with the AppBuilder.

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()
    {
        return AppBuilder.Configure<App>()
            .UsePlatformDetect()
            .LogToTrace()
            .WithIcons(container => container
                .Register<FontAwesomeIconProvider>()
                .Register<MaterialDesignIconProvider>());
    }
}

2. Add xml namespace

Add xmlns:i="clr-namespace:Projektanker.Icons.Avalonia;assembly=Projektanker.Icons.Avalonia" to your view.

3. Use the icon

Standalone

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

Attached to ContentControl (e.g. Button)

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

Attached to MenuItem

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

Animated
⚠️ There is currently a bug in Avalonia 11: https://github.com/AvaloniaUI/Avalonia/issues/8791

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

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 SVG path of the requested icon.
        /// </summary>
        /// <param name="value">The value specifying the icon to return it's path from.</param>
        /// <returns>The path of the icon.</returns>
        /// <exception cref="System.Collections.Generic.KeyNotFoundException">
        /// The icon associated with the specified <paramref name="value"/> does not exists.
        /// </exception>
        string GetIconPath(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:

container.Register<MyCustomIconProvider>()

or

IIconProvider provider = new MyCustomIconProvider(/* custom ctor arguments */);
container.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 (1)

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

Package Downloads
AvaloniaXT

Avalonia App Page Helper Dll , Contains MainWindow,SukiUI,Support AOT

GitHub repositories (12)

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

Repository Stars
GreemDev/Ryujinx
Nintendo Switch emulator written in C#, originally created by gdkchan.
LykosAI/StabilityMatrix
Multi-Platform Package Manager for Stable Diffusion
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.
Version Downloads Last updated
9.6.0 83 12/22/2024
9.5.0 1,858 11/24/2024
9.4.3 1,500 11/18/2024
9.4.2 123 11/18/2024
9.4.1 4,367 10/4/2024
9.4.0 26,470 7/21/2024
9.3.0 10,509 4/7/2024
9.2.0 897 3/29/2024
9.1.2 1,635 3/12/2024
9.1.1 5,181 2/22/2024
9.0.1 8,151 12/8/2023
9.0.0 597 12/6/2023
8.4.0 2,343 12/6/2023
8.3.0 7,436 10/11/2023
8.2.0 4,724 8/6/2023
8.1.0 1,016 7/26/2023
8.0.0 1,203 7/17/2023
7.0.1 1,250 7/16/2023
7.0.0 697 7/16/2023
6.6.0 1,807 7/10/2023
6.6.0-rc1.1 1,687 6/7/2023
6.6.0-preview6 957 4/26/2023
6.5.0-preview6 960 3/24/2023
6.5.0-preview5 780 2/28/2023
6.4.0-preview5 794 2/4/2023
6.3.0-preview4 994 12/12/2022
6.2.0-preview1 774 9/21/2022
6.1.0-preview1 613 8/29/2022
6.0.0-preview1 655 8/24/2022
5.13.0 3,766 4/26/2023
5.12.0 1,289 4/2/2023
5.11.0 997 3/26/2023
5.10.0 1,342 2/28/2023
5.9.0 1,614 2/12/2023
5.8.0 1,987 12/12/2022
5.7.0 786 12/12/2022
5.6.0 2,867 11/20/2022
5.5.0 12,155 9/4/2022
5.4.0 973 8/29/2022
5.3.0 2,165 7/31/2022
5.2.0 1,121 7/24/2022
5.1.0 2,524 7/3/2022
5.0.2 1,789 5/27/2022
5.0.1 1,174 5/23/2022
5.0.0 978 5/23/2022
4.5.0 891 5/22/2022
4.4.0 2,655 4/3/2022
4.3.0 1,041 3/27/2022
4.2.1 1,259 3/16/2022
4.2.0 979 3/14/2022
4.1.0 1,129 3/9/2022
4.0.1 933 3/8/2022
4.0.0 972 3/7/2022
3.7.1 2,256 12/15/2021
3.7.0 2,228 11/20/2021
3.5.0 914 11/12/2021
3.4.1 1,288 11/8/2021
3.4.0 839 11/8/2021
3.2.0 1,156 10/17/2021
3.1.4 953 10/14/2021
3.1.2 2,195 8/13/2021
3.1.1 931 8/11/2021
3.1.0 1,735 3/22/2021
3.0.0-pre 1,328 10/29/2020
2.0.2 1,249 8/12/2020
2.0.1 1,205 7/27/2020
2.0.0 1,152 7/27/2020
1.1.0 1,112 7/27/2020
1.0.0 1,201 7/27/2020 1.0.0 is deprecated because it has critical bugs.