Iconize Plugin for Xamarin Forms

A .NET for Xamarin port of the android-iconify project. Use icon fonts in your Xamarin.Forms application!

Updated to NetStandard 2.0, FontAwesome 5

NuGet

• Available on NuGet: http://www.nuget.org/packages/Xam.Plugin.Iconize

Build Status

• 
• CI NuGet Feed: https://ci.appveyor.com/nuget/iconize

Icon Fonts

• Entypo+
  • pictograms by Daniel Bruce
  • Version: 5/3, 2015
• Font Awesome
  • Version: 5.3.1
• Font Awesome Pro
  • Version: 5.3.1
• Ionicons
  • Version: 2.0.1
• Jam Icons
  • Version: 2.0.0
• Material design icons
  • Version: 3.0.1
• Meteocons
  • Version: 1.0
• Simple Line Icons
  • Version: 2.4.1
• Typicons
  • Version: 2.0.7
• Weather Icons
  • Version: 2.0.10

Font Requests
If you have an icon font or series of svg pictograms you'd like included, just submit an issue or pull request and we'll work to add it.

Extensibility
In case you can't find the icon you want, you can extend the available icon directly from your app. All you need to do is to implement IIconModule with a .ttf file in your assets/resources and provide the mapping between keys and special characters, then give it to Iconize.With().

There are no constraints on the icon keys, but I strongly suggest you use a unique prefix like my- or anything, to avoid conflicts with other modules. FYI, if there is a conflict, the first module declared with Iconize.With() has priority.

Controls

Xamarin.Forms

• IconButton (Button)
• IconImage (Image)
• IconLabel (Label)
• IconTabbedPage (TabbedPage)
• IconToolbarItem (ToolbarItem)
  • Requires IconNavigationPage

Setup

Install

Nuget
All packages are provided via NuGet.

• Xam.Plugin.Iconize
• Xam.Plugin.Iconize.EntypoPlus
• Xam.Plugin.Iconize.FontAwesome
• Xam.Plugin.Iconize.Ionicons
• Xam.Plugin.Iconize.JamIcons
• Xam.Plugin.Iconize.Material
• Xam.Plugin.Iconize.Meteocons
• Xam.Plugin.Iconize.SimpleLineIcons
• Xam.Plugin.Iconize.Typicons
• Xam.Plugin.Iconize.WeatherIcons

Configure

PCL Project
Initialize any number of modules in App.cs constructor.

public App()
{
    ...
    Plugin.Iconize.Iconize.With(new Plugin.Iconize.Fonts.EntypoPlusModule())
                          .With(new Plugin.Iconize.Fonts.FontAwesomeModule())
                          .With(new Plugin.Iconize.Fonts.IoniconsModule())
                          .With(new Plugin.Iconize.Fonts.MaterialModule())
                          .With(new Plugin.Iconize.Fonts.MeteoconsModule())
                          .With(new Plugin.Iconize.Fonts.SimpleLineIconsModule())
                          .With(new Plugin.Iconize.Fonts.TypiconsModule())
                          .With(new Plugin.Iconize.Fonts.WeatherIconsModule());
    ...
}

Xamarin.Android (AppCompat)
Initialize the IconControls.

protected override void OnCreate(Bundle savedInstanceState)
{
    Xamarin.Forms.Forms.Init(this, savedInstanceState);
    ...
    Plugin.Iconize.Iconize.Init(Resource.Id.toolbar, Resource.Id.sliding_tabs);
    ...
    LoadApplication(new App());
}

Xamarin.iOS (Unified)
Add the UIAppFonts key to Info.plist with the specific fonts you have chosen.

<key>UIAppFonts</key>
<array>
    <string>iconize-entypoplus.ttf</string>
    <string>iconize-fontawesome.ttf</string>
    <string>iconize-ionicons.ttf</string>
    <string>iconize-material.ttf</string>
    <string>iconize-meteocons.ttf</string>
    <string>iconize-simplelineicons.ttf</string>
    <string>iconize-typicons.ttf</string>
    <string>iconize-weathericons.ttf</string>
</array>

Xamarin.Forms with Caliburn Micro
Add the following to App.cs

protected override NavigationPage CreateApplicationPage()
{
    return new IconNavigationPage();
}

Contributions

• Jeremy Marcus @jsmarcus
• Riccardo Marraghini @marra85
• Kevin Petit @kvpt
• Aaron @veeprox
• Matthias Bruzek @bruzkovsky
• Philipp Sumi @hardcodet
• @andooown
• Julien Binet @lanarchyste

License

This work is licensed under the Apache License, Version 2.0.

Entypo+
Entypo+ is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)

Font Awesome
Font Awesome is licensed under the SIL Open Font License 1.1.

Font Awesome Pro
Font Awesome Pro is commercial software that requires a paid license. Full Font Awesome Pro license. As a consequence the font files are not bundled with the plugin and need to be added manually.

Ionicons
Ionicons is licensed under the MIT License.

Jam Icons
Jam Icons is licensed under the MIT License.

Material design icons
Material design icons are licensed under the Apache License, Version 2.0.

Meteocons
Meteocons are provided as free icons by the creator, Alessio Atzeni.

Simple Line Icons
Simple Line Icons are licensed under the MIT License.

Typicons
Typicons is licensed under the SIL Open Font License 1.1.

Weather Icons
Weather Icons are licensed under the SIL Open Font License 1.1.

Brand Icons
All brand icons are trademarks of their respective owners. The use of these trademarks does not indicate endorsement of the trademark holder by Iconize, nor vice versa. Brand icons should only be used to represent the company or product to which they refer.