Material.Icons.Avalonia 3.0.0

Material.Icons

Parsed icons set from materialdesignicons.com and display control implementations for different GUI frameworks.

• All icons are always up-to-date because automatically updated every 6 hours.
• Small package size because icons are graphically encoded via SVG Path.
• Icon types are strongly typed enum, so your IDE will suggest available variants:
  

Structure

This project consists of 3 parts:

• contains info about the icons

• contains controls for AvaloniaUI

• contains controls for WPF

• contains controls for WinUI3

• FAQ - frequently asked questions

Community maintained

• contains controls for WinUI/UNO (separate repository)

Avalonia

Getting started

1. Install Material.Icons.Avalonia nuget package:

   dotnet add package Material.Icons.Avalonia
   

   
2. Include styles in App.xaml (for 2.0.0 version and higher):

   <Application xmlns:materialIcons="clr-namespace:Material.Icons.Avalonia;assembly=Material.Icons.Avalonia" 
                ...>
     <Application.Styles>
       ...
       <materialIcons:MaterialIconStyles />
     </Application.Styles>
   </Application>
   

Using

Add Material.Icons.Avalonia namespace to the root element of your file (your IDE can suggest it or do it automatically):

xmlns:materialIcons="clr-namespace:Material.Icons.Avalonia;assembly=Material.Icons.Avalonia"

Use MaterialIcon control:

<materialIcons:MaterialIcon Kind="Abacus" />

The Foreground property controls the color of the icon.
Also, there is MaterialIconExt which allows you to use is as the markup extension:

<Button Content="{materialIcons:MaterialIconExt Kind=Abacus}" />

Or with a text via MaterialIconTextExt:

<Button Content="{materialIcons:MaterialIconTextExt Kind=Play, Text=Play}" />

The MaterialIcon implements IImage interface, to allow to use as an Image source:

<Image>
    <materialIcons:MaterialIcon Foreground="DeepPink" Kind="Abacus" />
</Image>


<Image Source="{materialIcons:MaterialIconExt Kind=Abacus, IconForeground=DeepPink}" />

Note that when using MaterialIcon as an Image source, the Width and Height properties must be defined under <Image>, any size definition on MaterialIcon have no impact. Also, animation are not supported in this use case.

Classes

• Fill: Fits to size within the parent control
• NullAsInvisible: {x:Null}(Default) icons will not reserve space for it in layout.

Avalonia FuncUI (F#)

Getting started

1. Install Material.Icons.Avalonia nuget package:

   dotnet add package Material.Icons.Avalonia
   

   
2. Import styles in Application (or if you use XAML check instructions for plain Avalonia)

   type App() =
       inherit Application()
   
       override this.Initialize() =
           ..
           this.Styles.Add(MaterialIconStyles(null))
           ..
   

3. Create bindings for MaterialIcon

   namespace Avalonia.FuncUI.DSL
   
   [<AutoOpen>]
   module MaterialIcon =
       open Material.Icons
       open Material.Icons.Avalonia
       open Avalonia.FuncUI.Types
       open Avalonia.FuncUI.Builder
   
       let create (attrs: IAttr<MaterialIcon> list): IView<MaterialIcon> =
           ViewBuilder.Create<MaterialIcon>(attrs)
   
       type MaterialIcon with
   
           static member kind<'t when 't :> MaterialIcon>(value: MaterialIconKind) : IAttr<'t> =
               AttrBuilder<'t>.CreateProperty<MaterialIconKind>(MaterialIcon.KindProperty, value, ValueNone)
   

4. Use

   Button.create [
        Button.content (
            MaterialIcon.create [
                MaterialIcon.kind MaterialIconKind.Export
           ]
       )
   ]
   

WPF

Getting started

Install Material.Icons.WPF nuget package:

dotnet add package Material.Icons.WPF

Using

Add Material.Icons.WPF namespace to the root element of your file (your IDE can suggest it or do it automatically):

xmlns:materialIcons="clr-namespace:Material.Icons.WPF;assembly=Material.Icons.WPF"

Use MaterialIcon control:

<materialIcons:MaterialIcon Kind="Abacus" />

The Foreground property controls the color of the icon.
Also, there is MaterialIconExt which allows you to use is as the markup extension:

<Button Content="{materialIcons:MaterialIconExt Kind=Abacus}" />

WinUI3

Getting started

Install Material.Icons.WinUI3 nuget package:

dotnet add package Material.Icons.WinUI3

Using

Add Material.Icons.WinUI3 namespace to the root element of your file (your IDE can suggest it or do it automatically):

xmlns:materialIcons="using:Material.Icons.WinUI3"

Use MaterialIcon control:

<materialIcons:MaterialIcon Kind="Abacus" />

The Foreground property controls the color of the icon.
Also, there is MaterialIconExt which allows you to use is as the markup extension:

<Button Content="{materialIcons:MaterialIconExt Kind=Abacus}" />

Meta

Getting started

Install Material.Icons nuget package:

dotnet add package Material.Icons

Using

Icon types stored in Material.Icons.MaterialIconKind enum.
We can resolve an icon path by using Material.Icons.MaterialIconDataProvider.GetData().

Adding your own icons

Currently, there is no way to add your own icons, as icons are enum and cannot be modified.
But you can override some existing icons to use your own data:

public class CustomIconProvider : MaterialIconDataProvider
{
    public override string ProvideData(MaterialIconKind kind)
    {
        return kind switch
        {
            MaterialIconKind.TrophyVariant => "some SVG code",
            _ => base.ProvideData(kind)
        };
    }
}

// When your application starts (e.g. in the Main method) replace MaterialIconDataProvider with your own
public static int Main(string[] args)
{
    MaterialIconDataProvider.Instance = new CustomIconProvider(); // Settings custom provider

    // Application startup code
    // return BuildAvaloniaApp().StartWithClassicDesktopLifetime(args);
}

Animations

MaterialIcon and it extensions supports pre-defined animations:

• None
• Spin (Circular spinning)
• SpinCcw (Circular spinning in CCW)
• Pulse (Step circular spinning)
• PulseCcw (Step circular spinning in CCW)
• FadeOutIn (Fade out and in)
• FadeInOut (Fade in and out)

<MaterialIcons:MaterialIcon Kind="Refresh" Animation="Spin" />
<MaterialIcons:MaterialIcon Kind="Heart" Foreground="DeepPink" Animation="FadeInOut" />

FAQ

How to change icon color?

• Change Foreground property.

How to change size?

• If you are using MaterialIcon control - use Width or/and Height properties.
• If you are using MaterialIconExt - use Size property.

How to update icons?

• You can manually set Material.Icons package version in your project file.

What about versioning policy?

• We use semver.
  Any package with identical major and minor versions is compatible.
  For example, 1.0.0 and 1.0.1 are compatible, but 1.0.0 and 1.1.0 might not be.