Projektanker.Icons.Avalonia.MaterialDesign 9.5.0

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

// Install Projektanker.Icons.Avalonia.MaterialDesign as a Cake Tool
#tool nuget:?package=Projektanker.Icons.Avalonia.MaterialDesign&version=9.5.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

This package is not used by any NuGet packages.

GitHub repositories (6)

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

Repository Stars
GreemDev/Ryujinx
Nintendo Switch emulator written in C#, originally created by gdkchan.
TEdit/Terraria-Map-Editor
TEdit - Terraria Map Editor - TEdit is a stand alone, open source map editor for Terraria. It lets you edit maps just like (almost) paint! It also lets you change world settings (time, bosses downed etc), edit chests and change sign, make epic dungeons, castles, cities, and add rewards for your adventurers!
sn4k3/UVtools
MSLA/DLP, file analysis, calibration, repair, conversion and manipulation
Nexus-Mods/NexusMods.App
Home of the development of the Nexus Mods App
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 113 12/22/2024
9.5.0 1,408 11/24/2024
9.4.3 462 11/18/2024
9.4.2 116 11/18/2024
9.4.1 4,377 10/4/2024
9.4.0 23,827 7/21/2024
9.3.0 19,145 4/7/2024
9.2.0 591 3/29/2024
9.1.2 5,280 3/12/2024
9.1.1 1,842 2/22/2024
9.0.1 4,673 12/8/2023
9.0.0 234 12/6/2023
8.4.0 151 12/6/2023
8.3.0 3,521 10/11/2023
8.2.0 2,130 8/6/2023
8.1.0 319 7/26/2023
8.0.0 548 7/17/2023
7.0.1 730 7/16/2023
7.0.0 191 7/16/2023
6.6.0 214 7/10/2023
6.6.0-rc1.1 4,481 6/7/2023
6.6.0-preview6 345 4/26/2023
6.5.0-preview6 966 3/24/2023
6.5.0-preview5 662 2/28/2023
6.4.0-preview5 195 2/4/2023
6.3.0-preview4 1,079 12/12/2022
6.2.0-preview1 230 9/21/2022
6.1.0-preview1 177 8/29/2022
6.0.0-preview1 158 8/24/2022
5.13.0 1,714 4/26/2023
5.12.0 573 4/2/2023
5.11.0 364 3/26/2023
5.10.0 511 2/28/2023
5.9.0 444 2/12/2023
5.8.0 676 12/12/2022
5.7.0 307 12/12/2022
5.6.0 575 11/20/2022
5.5.0 863 9/4/2022
5.4.0 464 8/29/2022
5.3.0 581 7/31/2022
5.2.0 618 7/24/2022
5.1.0 681 7/3/2022
5.0.2 1,041 5/27/2022
5.0.1 461 5/23/2022
5.0.0 439 5/23/2022
4.5.0 440 5/22/2022
4.4.0 865 4/3/2022
4.3.0 491 3/27/2022
4.2.1 531 3/16/2022
4.2.0 465 3/14/2022
4.1.0 523 3/9/2022
4.0.1 478 3/8/2022
4.0.0 475 3/7/2022
3.7.1 625 12/15/2021
3.7.0 1,247 11/20/2021
3.6.0 429 11/14/2021
3.5.0 374 11/12/2021
3.4.1 361 11/8/2021
3.4.0 409 11/8/2021
3.3.0 486 10/25/2021
3.2.0 506 10/17/2021