Android-Iconics

If you are an app developer you will know the problem. You start an app but require many different icons, in different sizes (ldpi, mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi), different colors, and different variants. If you get the icons as vector (.svg) or there are many changes over the time, you will always have to get the correct drawables again.

This consumes a lot of time!

Now there's an easy, fast, and small solution for this! The Android-Iconics library.

This library allows you to include vector icons everywhere in your project. No limits are given. Scale with no limit, use any color at any time, provide a contour, and many additional customizations...

Use the icons in the variation you need them.

What do you get

No customization limitations (size, color, contour, background, padding, positioning, ...)
Shadow support
One icon source (no more mdpi, hdpi, ...)
Flexibility
- Size
- Colors
- Contour
- Shadow
- Auto mirroring for RTL (opt-in)
If it takes a Drawable, it will also work with the IconicsDrawable!
Save in APK size
All licenses included, best used with AboutLibraries

Already available fonts

Need more? Provide additional fonts for you project, or even create your custom font with just the icons you need.

String fields for icons

For generating string field for each of icons of your font, you can use this simple generator:

Android-Iconics String Generator

Android module generator

A awesome gradle plugin which can automatically fetch a font from Fontastic, and generate the Android Module for your project.

Iconics-Font-Generator

Migration

MIGRATION GUIDE

Setup

1. Provide the gradle dependency

//the core iconics library (without any widgets)
implementation "com.mikepenz:iconics-core:4.0.2"
implementation "androidx.appcompat:appcompat:${versions.appCompat}"

1b. (optional) Add the view's dependency

//this adds all ui view widgets (IconicsButton, IconicsImageView, ...)
implementation "com.mikepenz:iconics-views:4.0.2"

For the non kotlin variant please use a version smaller than 4.x.y (See the releases on GitHub) To use appcompat please use a version smaller than 3.1.0. (See the releases on GitHub)

2. Choose your desired fonts

implementation 'com.mikepenz:google-material-typeface:3.0.1.4.original-kotlin@aar'
implementation 'com.mikepenz:material-design-iconic-typeface:2.2.0.6-kotlin@aar'
implementation 'com.mikepenz:fontawesome-typeface:5.9.0.0-kotlin@aar'
implementation 'com.mikepenz:octicons-typeface:3.2.0.6-kotlin@aar'
implementation 'com.mikepenz:meteocons-typeface:1.1.0.5-kotlin@aar'
implementation 'com.mikepenz:community-material-typeface:3.5.95.1-kotlin@aar'
implementation 'com.mikepenz:weather-icons-typeface:2.0.10.5-kotlin@aar'
implementation 'com.mikepenz:typeicons-typeface:2.0.7.5-kotlin@aar'
implementation 'com.mikepenz:entypo-typeface:1.0.0.5-kotlin@aar'
implementation 'com.mikepenz:devicon-typeface:2.0.0.5-kotlin@aar'
implementation 'com.mikepenz:foundation-icons-typeface:3.0.0.5-kotlin@aar'
implementation 'com.mikepenz:ionicons-typeface:2.0.1.5-kotlin@aar'
implementation 'com.mikepenz:pixeden-7-stroke-typeface:1.2.0.3-kotlin@aar'
implementation 'com.mikepenz:material-design-icons-dx-typeface:5.0.1.0-kotlin@aar'

Usage

Use as drawable

IconicsDrawable(this)
    .icon(FontAwesome.Icon.faw_android)
    .color(Color.RED.toIconicsColor())
    .size(24.toIconicsSizeDp())

Use via XML

If you use the Iconics library via XML provide the icon you want to use in the following syntax: gmd-favorite --> fontId-iconName. A list of the available fonts and their fontId can be found here. All icon names from the default fonts can be found via the DEMO application.

Notation within text

Use the { icon-definer } syntax

Some great text with a {faw-android} font awesome icon and {met-wind} meteocons icons.

Custom Views

As IconicsImageView

<com.mikepenz.iconics.view.IconicsImageView
    android:layout_width="72dp"
    android:layout_height="72dp"
    app:iiv_color="@android:color/holo_red_dark"
    app:iiv_icon="gmd-favorite" />  // or @string/gmd_favorite with our generator
    //app:iiv_size="12dp"
    //app:iiv_padding="2dp"
    //app:iiv_contour_color="#FF0000"
    //app:iiv_contour_width="2dp"
    //app:iiv_background_color="#FFFF00"
    //app:iiv_corner_radius="2dp"
    //app:iiv_background_contour_color="#FF0000"
    //app:iiv_background_contour_width="1dp"
    //app:iiv_shadow_radius="4dp"
    //app:iiv_shadow_dx="1dp"
    //app:iiv_shadow_dy="1dp"
    //app:iiv_animations="spin|blink_alpha|blink_scale"

As IconicsTextView

<com.mikepenz.iconics.view.IconicsTextView
        android:text="abc{hif-test}defgh{faw-adjust}ijk{fon-test1}lmnopqrstuv{fon-test2}wxyz"
        android:textColor="@android:color/black"
        android:layout_width="wrap_content"
        android:layout_height="56dp"
        android:textSize="16sp"/>

As IconicsButton

<com.mikepenz.iconics.view.IconicsButton
        android:text="{faw-adjust} Button"
        android:layout_width="120dp"
        android:layout_height="60dp"/>

Automatic XML

Screenshots

Available fonts

Link	Prefix	Dependency
Google Material Design Icons ORIGINAL by Google	gmd	implementation 'com.mikepenz:google-material-typeface:+.original@aar'
Material Design Iconic Font Google Material Iconic	gmi	implementation 'com.mikepenz:material-design-iconic-typeface:+@aar'
Fontawesome	faw	implementation 'com.mikepenz:fontawesome-typeface:+@aar'
Meteocons	met	implementation 'com.mikepenz:meteocons-typeface:+@aar'
Octicons	oct	implementation 'com.mikepenz:octicons-typeface:+@aar'
Community Material	cmd	implementation 'com.mikepenz:community-material-typeface:+@aar'
Weather Icons	wic	implementation 'com.mikepenz:weather-icons-typeface:+@aar'
Typeicons	typ	implementation 'com.mikepenz:typeicons-typeface:+@aar'
Entypo	ent	implementation 'com.mikepenz:entypo-typeface:+@aar'
Devicon	dev	implementation 'com.mikepenz:devicon-typeface:+@aar'
Foundation Icons	fou	implementation 'com.mikepenz:foundation-icons-typeface:+@aar'
Ionicons	ion	implementation 'com.mikepenz:ionicons-typeface:+@aar'
Pixden7Stroke	pe7	implementation 'com.mikepenz:pixeden-7-stroke-typeface:+@aar'
Material Design DX	cmf	implementation 'com.mikepenz:material-design-icons-dx-typeface:+@aar'

Licenses for all included fonts are linked inside the class or can be found on the coresponding repositories.

Advanced Usage

Register fonts

If you want to add your own custom font, or a GenericFont you have to register this font (before using it). The best place to do this is the Application. You can manually provide applicationContext and trigger initialization, or you can use our IconicsContentProvider and do absolutely nothing.

If you want to use tha manual way - place this value into your resources

<bool name="is_iconics_content_provider_enabled">false</bool>

And initialize Iconics as you wish

class CustomApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        //only required if you add a custom or generic font on your own
        Iconics.init(applicationContext)

        //register custom fonts like this (or also provide a font definition file)
        Iconics.registerFont(CustomFont())
    }
}

Advanced IconicsBuilder

Everything is easy and simple. Right? But now you got a single icon within your textview and you need additional styling? Just define the style for all icons or only a specific one. You can find this in the PlaygroundActivity of the sample too.

Iconics.Builder()
    .style(ForegroundColorSpan(Color.WHITE), BackgroundColorSpan(Color.BLACK), RelativeSizeSpan(2f))
    .styleFor(FontAwesome.Icon.faw_adjust, BackgroundColorSpan(Color.RED))
                .on(tv1)
    .build()

String icon-key or typeface enum

Sometimes you won't like to use the icon-key ("faw-adjust") like this, but use the enum provided by a specific font. Both is valid:

IconicsDrawable(this, "faw-adjust").actionBar()

IconicsDrawable(this, FontAwesome.Icon.faw_adjust).size(24.toIconicsSizeDp()).padding(1.toIconicsSizeDp())

Create custom fonts

This is possible with only the *.ttf and *.css mapping file. And will take you 2 minutes.

You can get these two files by downloading a web icon font, or if you want to create your own custom icon font from *.svg files then you can use following tools:

Fontello
IcoMoon
Fontastic
let me know if you find other tools.

After you got those two files, head over to the icon addon creation tool android-iconics.mikepenz.com. Enter all the information. Add the *.ttf and *.css and click the button. It will generate and download the icon font addon as zip. (this tool is local only, no files are sent to a server, you can safely use it with any icons)

ProGuard

Exclude R from ProGuard to enable the font addon auto detection

-keep class .R
-keep class **.R$* {
    <fields>;
}

All other ProGuard rules are now bundled internally with each font.

Demo

You can try the sample application out. It's on Google Play ;) https://play.google.com/store/apps/details?id=com.mikepenz.iconics.sample

Special Contributor

Baptiste Lagache Thanks for the gradle font module generator
Also thanks for all the other contributors.

Credits

Joan Zapata He is the creator of Android-Iconify which gave me the idea of this project. Some core concepts and ideas were reused, but everything is written from scratch.
Christopher Jenkins Thanks for the great usage of a custom ContextWrapper inside Calligraphy
Stephan Schober

Developed By

Mike Penz
- mikepenz.com - mikepenz@gmail.com
- paypal.me/mikepenz
Peter Gulko
- github.com/zTrap

License

Copyright 2019 Mike Penz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

hichamboushaba/Android-Iconics