AathifMahir.Maui.MauiIcons.Material.Sharp 2.1.2

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

// Install AathifMahir.Maui.MauiIcons.Material.Sharp as a Cake Tool
#tool nuget:?package=AathifMahir.Maui.MauiIcons.Material.Sharp&version=2.1.2                

.Net Maui Icons

The .NET MAUI Icons - Material Sharp library serves as a lightweight icon library, addressing icon and font icon management in .NET MAUI by offering controls that utilize the comprehensive open-source version of the Material Icon Collection, seamlessly integrated into the library. Check out the Repository for Docs

Get Started

In order to use the .NET MAUI Icons - Material you need to call the extension method in your MauiProgram.cs file as follows:

using MauiIcons.Material.Sharp;

public static class MauiProgram
{
	public static MauiApp CreateMauiApp()
	{
		var builder = MauiApp.CreateBuilder();
		
		// Initialise the .Net Maui Icons - Material
		builder.UseMauiApp<App>().UseMaterialSharpMauiIcons();
	}
}

Usage

In order to make use of the .Net Maui Icons - Material Sharp you can use the below namespace:

Xaml

xmlns:mi="http://www.aathifmahir.com/dotnet/2022/maui/icons"

C#

using MauiIcons.Material.Sharp;

Workaround

if you came across this issue dotnet/maui#7503 when using new namespace, Make sure to create an discarded instance of MauiIcon in the codebehind like below


    public MainPage()
    {
        InitializeComponent();
        // Temporary Workaround for url styled namespace in xaml
        _ = new MauiIcon();
    }

Built in Control Usage

Xaml

<mi:MauiIcon Icon="{mi:MaterialSharp AddRoad}"/>

C#

new MauiIcon() {Icon = MaterialSharpIcons.AddRoad, IconColor = Colors.Green};

new MauiIcon().Icon(MaterialSharpIcons.ABC).IconColor(Colors.Purple);

All the Properties and Features of Built in Control, Check Here

Xaml Extension Usage

<Image Aspect="Center" Source="{mi:MaterialSharp Icon=ABC}"/>

<Label Text="{mi:MaterialSharp Icon=AddRoad}"/>

C# Markup Usage

new ImageButton().Icon(MaterialSharpIcons.AddRoad),

new Image().Icon(MaterialSharpIcons.ABC),

new Label().Icon(MaterialSharpIcons.AddRoad).IconSize(40.0).IconColor(Colors.Red),

new Entry().Icon(MaterialSharpIcons.ABC).IconSize(20.0).IconColor(Colors.Aqua),

Disclaimer: It's important to note that not all controls are compatible with C# markup. We have conducted tests with the following controls in the current release: Label, Image, ImageButton, SearchBar, Editor, and Entry. Additionally, the native MauiIcon control, when combined with C# markup, can prove to be quite versatile and offer extra features for various scenarios.

Applying Icon To Text or Placeholder

Controls that Supports Placeholder, Can Assign the Icon To PlaceHolder or Text, Defaults to Placeholder but can be set to Text by Setting isPlaceHolder Parameter to False

new Entry().Icon(MaterialSharpIcons.ABC, isPlaceHolder: false).IconSize(20.0).IconColor(Colors.Aqua);

new SearchBar().Icon(MaterialSharpIcons.AddRoad, isPlaceHolder: false);

Disclaimer: It's important to note that not all controls are compatible with C# markup. We have conducted tests with the following controls in the current release: Label, Image, ImageButton, SearchBar, Editor, and Entry. Additionally, the native MauiIcon control, when combined with C# markup, can prove to be quite versatile and offer extra features for various scenarios.

Custom OnPlatform and OnIdiom Usage

Xaml

<mi:MauiIcon Icon="{mi:MaterialSharp AddRoad}" OnPlatforms="WinUI, Android, MacCatalyst"/>
<mi:MauiIcon Icon="{mi:MaterialSharp ABC}" OnIdioms="Desktop, Phone, Tablet"/>
<mi:MauiIcon Icon="{mi:MaterialSharp AddRoad}" OnPlatforms="Android" OnIdioms="Phone"/>

C#

new MauiIcon().Icon(MaterialSharpIcons.AddRoad).OnPlatforms(new List<string>{"WinUI", "Android"});
new MauiIcon().Icon(MaterialSharpIcons.ABC).OnIdioms(new List<string>{"Desktop", "Phone"});
new MauiIcon().Icon(MaterialSharpIcons.AddRoad).OnPlatforms(new List<string>{"WinUI", "Android"}).OnIdioms(new List<string>{"Desktop", "Phone"});

Maui Built in OnPlatform and OnIdiom Usage

<Image>
    <Image.Source>
        <OnPlatform x:TypeArguments="ImageSource" Default="{mi:MaterialSharp Icon=ABC, TypeArgument={x:Type ImageSource}}">
            <On Platform="MacCatalyst, WinUI" 
			Value="{mi:MaterialSharp Icon=AddRoad, IconBackgroundColor=Cyan, TypeArgument={x:Type ImageSource}}"/>
        </OnPlatform>
    </Image.Source>
</Image>

<Image>
    <Image.Source>
        <OnIdiom Default="{mi:MaterialSharp Icon=AddRoad, TypeArgument={x:Type ImageSource}}" 
		Desktop="{mi:MaterialSharp Icon=ABC, TypeArgument={x:Type ImageSource}}">
        </OnIdiom>
    </Image.Source>
</Image>

Disclaimer: Only ImageSource or FontImageSource Supports Maui's Built in OnPlatform or OnIdiom and TypeArgument Should be Assigned to Work Optimally, Therefore It's Recommended to use MauiIcons Custom OnPlatform and OnIdioms

License

MauiIcons.Material.Sharp
MauiIcons.Material.Sharp is Licensed Under MIT License.

Material Design Icons Material Design Icons is Licensed Under Apache License 2.0.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-android33.0 is compatible.  net7.0-ios was computed.  net7.0-ios16.1 is compatible.  net7.0-maccatalyst was computed.  net7.0-maccatalyst16.1 is compatible.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net7.0-windows10.0.19041 is compatible.  net8.0 is compatible.  net8.0-android was computed.  net8.0-android34.0 is compatible.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst17.2 is compatible.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows10.0.19041 is compatible. 
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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 95 10/17/2024
3.0.0 238 5/11/2024
2.2.5 153 5/6/2024 2.2.5 is deprecated because it has critical bugs.
2.2.0-pre 128 5/4/2024
2.1.5 285 4/1/2024
2.1.2 135 3/17/2024
2.1.1 278 2/1/2024
2.1.0 234 12/23/2023
2.0.0 203 11/17/2023
2.0.0-rc1.1 77 11/14/2023

v2.1.2
• Minor Fixes and Improvements for Base Extension

v2.1.1
• Minor Patch on Issue #83

v2.1.0
• Docs Update

v2.0.0
• New Modular Core
• Major Core Control Enhancements
• Icon Suffix Support on Core Control
• Major Core Extension Enhanecements and Support for C# Markup Extension
• New C# Markup Extension for Maui Built in Controls
• New OnPlatform and OnIdioms Support
• Improved Docs