Projektanker.Icons.Avalonia 3.1.4

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

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

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 Free Nuget

Usage

A full example is available in the demo directory.

1. Register icon providers on app start up

Use the AppBuilder.AfterSetup method to register a callback. Within this callback register the icon prodider(s). Otherwise the visual designer won't be able to use the registered icon provider(s).

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>()
            .AfterSetup(AfterSetupCallback)
            .UsePlatformDetect()
            .LogToTrace();
    }
    
    // Called after setup
    private static void AfterSetupCallback(AppBuilder appBuilder)
    {
        // Register icon provider(s)
        IconProvider.Register<FontAwesomeIconProvider>();
    }
}

2. Add xml namespace

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

3. Use the icon

Example: The GitHub icon.
FontAwesome

<i class="fab fa-github"></i>

Standalone

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

Attached

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

Done

Screenshot
Screenshot

Implement your own Icon Provider

Just implement the IIconProvider interface:

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

        /// <summary>
        /// Gets the SVG path of the requested icon using the registered icon providers.
        /// </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);
    }
}

and register it with the IconProvider:

IconProvider.Register<MyCustromIconProvider>()

or

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

The IIconProvider.Prefix property have 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 (2)

Showing the top 2 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.

GitHub repositories (6)

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

Repository Stars
sn4k3/UVtools
MSLA/DLP, file analysis, calibration, repair, conversion and manipulation
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
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 1,940 3/12/2024
9.1.1 1,551 2/22/2024
9.0.1 8,001 12/8/2023
9.0.0 550 12/6/2023
8.4.0 1,188 12/6/2023
8.3.0 8,449 10/11/2023
8.2.0 4,521 8/6/2023
8.1.0 959 7/26/2023
8.0.0 1,156 7/17/2023
7.0.1 972 7/16/2023
7.0.0 606 7/16/2023
6.6.0 1,665 7/10/2023
6.6.0-rc1.1 5,238 6/7/2023
6.6.0-preview6 961 4/26/2023
6.5.0-preview6 1,428 3/24/2023
6.5.0-preview5 1,110 2/28/2023
6.4.0-preview5 703 2/4/2023
6.3.0-preview4 1,685 12/12/2022
6.2.0-preview1 711 9/21/2022
6.1.0-preview1 501 8/29/2022
6.0.0-preview1 535 8/24/2022
5.13.0 4,254 4/26/2023
5.12.0 1,394 4/2/2023
5.11.0 989 3/26/2023
5.10.0 1,413 2/28/2023
5.9.0 1,597 2/12/2023
5.8.0 2,077 12/12/2022
5.7.0 1,010 12/12/2022
5.6.0 2,679 11/20/2022
5.5.0 5,483 9/4/2022
5.4.0 1,357 8/29/2022
5.3.0 2,404 7/31/2022
5.2.0 1,629 7/24/2022
5.1.0 2,893 7/3/2022
5.0.2 2,544 5/27/2022
5.0.1 1,519 5/23/2022
5.0.0 1,306 5/23/2022
4.5.0 1,280 5/22/2022
4.4.0 3,153 4/3/2022
4.3.0 1,433 3/27/2022
4.2.1 1,575 3/16/2022
4.2.0 1,329 3/14/2022
4.1.0 1,573 3/9/2022
4.0.1 1,384 3/8/2022
4.0.0 1,423 3/7/2022
3.7.1 2,565 12/15/2021
3.7.0 2,465 11/20/2021
3.5.0 1,117 11/12/2021
3.4.1 1,499 11/8/2021
3.4.0 1,240 11/8/2021
3.2.0 1,455 10/17/2021
3.1.4 1,005 10/14/2021
3.1.2 2,208 8/13/2021
3.1.1 986 8/11/2021
3.1.0 1,797 3/22/2021
3.1.0-pre 241 3/22/2021
3.0.0 948 10/29/2020
3.0.0-pre 783 10/29/2020
2.0.2 1,160 8/12/2020
2.0.1 1,142 7/27/2020
2.0.0 1,080 7/27/2020
1.0.0 1,016 7/27/2020