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 an Drawable, it will also work with the IconicsDrawable!
- Save in APK size
Already available fonts
- FontAwesome
- Material Design Icons
- Meteocons
- Octicons
- Community Material Icons
Need more? Provide additional fonts for you project, or even create your custom font with just the icons you need.
UPGRADE < v2.0.0
- there is now a core package which comes without included fonts
- provide the fonts you need. no additional steps required
#Setup
##1. Provide the gradle dependency
dependencies {
compile 'com.mikepenz:iconics-core:1.7.0@aar'
}
##2. Choose your desired fonts
compile 'com.mikepenz:google-material-typeface:1.2.0@aar'
compile 'com.mikepenz:fontawesome-typeface:4.4.0@aar'
compile 'com.mikepenz:octicons-typeface:2.2.2@aar'
compile 'com.mikepenz:meteocons-typeface:1.1.3@aar'
compile 'com.mikepenz:community-material-typeface:1.1.72@aar'
#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.
###As ImageView
<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 Text
To use the icon within text use the {
icon-definer }
syntax
Some great text with a {faw-android} font awesome icon and {met-wind} meteocons icons.
####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"/>
#Screenshots
#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());
//Generic font creation process
GenericFont gf2 = new GenericFont("gmf", "fonts/materialdrawerfont.ttf");
gf2.registerIcon("person", '\ue800');
gf2.registerIcon("up", '\ue801');
gf2.registerIcon("down", '\ue802');
Iconics.registerFont(gf2);
}
}
###Create custom fonts using Fontello
Chapter will be added soon
###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)
#Available fonts
- Fontawesome
- "faw"
- DEFAULT
- Google Material Design Icons
- "gmd"
- DEFAULT
- Meteocons
- "met"
- compile 'com.mikepenz.iconics:meteocons-typeface:+@aar'
- Octicons
- "oct"
- compile 'com.mikepenz.iconics:octicons-typeface:+@aar'
- Community Material
- "cmd"
- compile 'com.mikepenz.iconics:community-material-typeface:+@aar'
#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.
#Developed By
- Mike Penz - http://mikepenz.com - mikepenz@gmail.com
#License
Copyright 2015 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.