basirsharif / android-iconics Goto Github PK

#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, ...)
• One icon source (no more mdpi, hdpi, ...)
• Flexibility
• 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

• Google Material Design Icons
• Material Design Iconic Font
• Fontawesome
• Meteocons
• Octicons
• Community Material
• Weather Icons
• Typeicons
• Entypo
• Devicon
• Foundation Icons
• Ionicons

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

#Migration

• MIGRATION GUIDE

#Setup

##1. Provide the gradle dependency

compile "com.mikepenz:iconics-core:2.8.1@aar"
compile "com.android.support:appcompat-v7:${supportLibVersion}"

##2. Choose your desired fonts

compile 'com.mikepenz:google-material-typeface:2.2.0.3.original@aar' 
compile 'com.mikepenz:material-design-iconic-typeface:2.2.0.2@aar'
compile 'com.mikepenz:fontawesome-typeface:4.7.0.0@aar'
compile 'com.mikepenz:octicons-typeface:3.2.0.2@aar'
compile 'com.mikepenz:meteocons-typeface:1.1.0.2@aar'
compile 'com.mikepenz:community-material-typeface:1.7.22.1@aar'
compile 'com.mikepenz:weather-icons-typeface:2.0.10.2@aar'
compile 'com.mikepenz:typeicons-typeface:2.0.7.2@aar'
compile 'com.mikepenz:entypo-typeface:1.0.0.2@aar'
compile 'com.mikepenz:devicon-typeface:2.0.0.2@aar'
compile 'com.mikepenz:foundation-icons-typeface:3.0.0.2@aar'
compile 'com.mikepenz:ionicons-typeface:2.0.1.2@aar'

##3. Define IconicsLayoutInflater to enable automatic xml icons detection (optional) Set the IconicsLayoutInflater as new LayoutInflaterFactory. This will enable automatic icon detection for TextViews,Buttons, and allow you to set icons on ImageView's via xml. This is compatible with libs which wrap the baseContext like Calligraphy. This does not work on FAB's please use the Context-Injection instead.

@Override
protected void onCreate(Bundle savedInstanceState) {
    LayoutInflaterCompat.setFactory(getLayoutInflater(), new IconicsLayoutInflater(getDelegate()));
    //...
    super.onCreate(savedInstanceState);
    //...
}

###3. ALTERNATIVE: Inject into Context (optional) Wrap the Activity context. This will enable the same features as Step 3.1., but is not compatible with other libs wrapping the baseContext.

@Override
protected void attachBaseContext(Context newBase) {
    super.attachBaseContext(IconicsContextWrapper.wrap(newBase));
}

#Usage ##Use as drawable

new IconicsDrawable(this)
    .icon(FontAwesome.Icon.faw_android)
    .color(Color.RED)
    .sizeDp(24)

##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 near the end of the README.md 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.

###As ImageView (only available if you follow Step 3 or inject the context)

<ImageView
    android:layout_width="48dp"
    android:layout_height="48dp"
    app:ico_color="@color/md_red_A200"
    app:ico_icon="gmd-plus-circle"
    app:ico_size="48dp" />
    
    //other possible attributes
    //app:ico_background_color="@android:color/transparent"
    //app:ico_color="@color/md_red_100"
    //app:ico_contour_color="@android:color/transparent"
    //app:ico_contour_width="0dp"
    //app:ico_corner_radius="0dp"
    //app:ico_icon="gmd-plus-circle"
    //app:ico_offset_x="0dp"
    //app:ico_offset_y="0dp"
    //app:ico_padding="0dp"
    //app:ico_size="48dp"

###As TextView (only available if you inject the context)

<TextView
    android:text="{gmd-chart} Chart"
    android:textColor="@android:color/black"
    android:layout_width="wrap_content"
    android:layout_height="56dp"
    android:textSize="16sp"/>

###Custom Views (if you do NOT follow Step 3 or inject the context) ####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" />

####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

• Google Material Design Icons
  • "gmd"
  • ORIGINAL by Google compile 'com.mikepenz:google-material-typeface:+.original@aar'
• Material Design Iconic Font
  • "gmi"
  • Google Material Iconic compile 'com.mikepenz:material-design-iconic-typeface:+@aar'
• Fontawesome
  • "faw"
  • compile 'com.mikepenz:fontawesome-typeface:+@aar'
• Meteocons
  • "met"
  • compile 'com.mikepenz:meteocons-typeface:+@aar'
• Octicons
  • "oct"
  • compile 'com.mikepenz:octicons-typeface:+@aar'
• Community Material
  • "cmd"
  • compile 'com.mikepenz:community-material-typeface:+@aar'
• Weather Icons
  • "wic"
  • compile 'com.mikepenz:weather-icons-typeface:+@aar'
• Typeicons
  • "typ"
  • compile 'com.mikepenz:typeicons-typeface:+@aar'
• Entypo
  • "ent"
  • compile 'com.mikepenz:entypo-typeface:+@aar'
• Devicon
  • "dev"
  • compile 'com.mikepenz:devicon-typeface:+@aar'
• Foundation Icons
  • "fou"
  • compile 'com.mikepenz:foundation-icons-typeface:+@aar'
• Ionicons
  • "ion"
  • compile 'com.mikepenz:ionicons-typeface:+@aar'

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

#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.

public class CustomApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

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

        //register custom fonts like this (or also provide a font definition file)
        Iconics.registerFont(new 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.

new Iconics.IconicsBuilder().ctx(this)
                .style(new ForegroundColorSpan(Color.WHITE), new BackgroundColorSpan(Color.BLACK), new RelativeSizeSpan(2f))
                .styleFor(FontAwesome.Icon.faw_adjust, new 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:

  new IconicsDrawable(this, "faw-adjust").actionBarSize()

  new IconicsDrawable(this, FontAwesome.Icon.faw_adjust).sizeDp(24)

##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

#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 - [email protected]
• paypal.me/mikepenz

#License

Copyright 2016 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.