Projektanker.Icons.Avalonia.FontAwesome 6.6.0-preview6

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.6.0-preview6
NuGet\Install-Package Projektanker.Icons.Avalonia.FontAwesome -Version 6.6.0-preview6
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.6.0-preview6" />
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.6.0-preview6
#r "nuget: Projektanker.Icons.Avalonia.FontAwesome, 6.6.0-preview6"
#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.6.0-preview6&prerelease

// Install Projektanker.Icons.Avalonia.FontAwesome as a Cake Tool
#tool nuget:?package=Projektanker.Icons.Avalonia.FontAwesome&version=6.6.0-preview6&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 (6)

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

Repository Stars
LykosAI/StabilityMatrix
Multi-Platform Package Manager for Stable Diffusion
sn4k3/UVtools
MSLA/DLP, file analysis, calibration, repair, conversion and manipulation
fifty-six/Scarab
An installer for Hollow Knight mods written in Avalonia.
Ombrelin/plex-rich-presence
A desktop app to enable discord rich presence for your Plex Media Server Activity
telstrapurple/PurpleExplorer
cross-platform Azure Service Bus explorer (Windows, MacOS, Linux)
Version Downloads Last updated
9.1.2 870 3/12/2024
9.1.1 1,262 2/22/2024
9.0.1 5,291 12/8/2023
9.0.0 496 12/6/2023
8.4.0 1,186 12/6/2023
8.3.0 6,513 10/11/2023
8.2.0 4,354 8/6/2023
8.1.0 927 7/26/2023
8.0.0 1,121 7/17/2023
7.0.1 972 7/16/2023
7.0.0 625 7/16/2023
6.6.0 1,639 7/10/2023
6.6.0-rc1.1 1,045 6/7/2023
6.6.0-preview6 881 4/26/2023
6.5.0-preview6 843 3/24/2023
6.5.0-preview5 688 2/28/2023
6.4.0-preview5 717 2/4/2023
6.3.0-preview4 891 12/12/2022
6.2.0-preview1 710 9/21/2022
6.1.0-preview1 542 8/29/2022
6.0.0-preview1 595 8/24/2022
5.13.0 3,603 4/26/2023
5.12.0 1,223 4/2/2023
5.11.0 915 3/26/2023
5.10.0 1,254 2/28/2023
5.9.0 1,406 2/12/2023
5.8.0 1,802 12/12/2022
5.7.0 743 12/12/2022
5.6.0 2,267 11/20/2022
5.5.0 5,072 9/4/2022
5.4.0 911 8/29/2022
5.3.0 1,951 7/31/2022
5.2.0 1,057 7/24/2022
5.1.0 2,442 7/3/2022
5.0.2 1,678 5/27/2022
5.0.1 1,087 5/23/2022
5.0.0 898 5/23/2022
4.5.0 834 5/22/2022
4.4.0 2,574 4/3/2022
4.3.0 981 3/27/2022
4.2.1 1,151 3/16/2022
4.2.0 893 3/14/2022
4.1.0 1,047 3/9/2022
4.0.1 876 3/8/2022
4.0.0 932 3/7/2022
3.7.1 2,159 12/15/2021
3.7.0 2,046 11/20/2021
3.5.0 849 11/12/2021
3.4.1 1,230 11/8/2021
3.4.0 780 11/8/2021
3.2.0 1,083 10/17/2021
3.1.4 881 10/14/2021
3.1.2 2,092 8/13/2021
3.1.1 863 8/11/2021
3.1.0 1,666 3/22/2021
3.0.0-pre 1,262 10/29/2020
2.0.2 1,186 8/12/2020
2.0.1 1,107 7/27/2020
2.0.0 1,081 7/27/2020
1.1.0 981 7/27/2020
1.0.0 1,058 7/27/2020