What's included 🚀

Setup

Latest releases 🛠

1. Provide the gradle dependency

dependencies {//the core iconics library (without any widgets)    implementation"com.mikepenz:iconics-core:${latestAndroidIconicsRelease}"    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:${latestAndroidIconicsRelease}"

2. Choose your desired fonts

Note

Fonts ending with-kotlin require at least v4.x of Android-Iconicsv5.1.x or newer requires the latest font versions

implementation'com.mikepenz:google-material-typeface:4.0.0.3-kotlin@aar'implementation'com.mikepenz:google-material-typeface-{outlined|rounded|sharp}:4.0.0.2-kotlin@aar'implementation'com.mikepenz:material-design-iconic-typeface:2.2.0.9-kotlin@aar'implementation'com.mikepenz:fontawesome-typeface:5.9.0.3-kotlin@aar'implementation'com.mikepenz:octicons-typeface:11.1.0.1-kotlin@aar'implementation'com.mikepenz:meteocons-typeface:1.1.0.8-kotlin@aar'implementation'com.mikepenz:community-material-typeface:7.0.96.1-kotlin@aar'// note 5.3.45.1 and newer alphabetically sorts, and merges in 3 sectionsimplementation'com.mikepenz:weather-icons-typeface:2.0.10.8-kotlin@aar'implementation'com.mikepenz:typeicons-typeface:2.0.7.8-kotlin@aar'implementation'com.mikepenz:entypo-typeface:1.0.0.8-kotlin@aar'implementation'com.mikepenz:devicon-typeface:2.0.0.8-kotlin@aar'implementation'com.mikepenz:foundation-icons-typeface:3.0.0.8-kotlin@aar'implementation'com.mikepenz:ionicons-typeface:2.0.1.8-kotlin@aar'implementation'com.mikepenz:pixeden-7-stroke-typeface:1.2.0.6-kotlin@aar'implementation'com.mikepenz:material-design-icons-dx-typeface:5.0.1.3-kotlin@aar'implementation'com.mikepenz:phosphor-typeface:1.0.0.1-kotlin@aar'implementation'com.mikepenz:simple-icons-typeface:17.0.0.3@aar'

Note

For users of the version catalog, it is not possible to add the type, however you can do so viathe implementation definition.implementation(libs.material.typeface) { artifact { type = "aar" } }

Warning

The fonts use thejetpack startup library to automatically register themselves.Ifjetpack startup is disabled,it is required to manually register the fonts. Please find additional details intheRegister fonts.

Usage

Note

It might be required to callIconics.init(applicationContext) if no context based APIs are usedfrom the library otherwise.

Use as drawable

IconicsDrawable(this,FontAwesome.Icon.faw_android).apply {    colorInt=Color.RED    sizeDp=24}

Use via XML

Notation within text

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

Drawable XML (API 24+)

<com.mikepenz.iconics.IconicsDrawablexmlns:app="http://schemas.android.com/apk/res-auto"app:ico_icon="gmd_favorite"app:ico_color="#0000FF"app:ico_contour_width="1dp"app:ico_contour_color="#00FFFF"app:ico_size="24dp" />    // all custom theming attributes supported

Custom Views

As IconicsImageView

<com.mikepenz.iconics.view.IconicsImageViewandroid: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.IconicsTextViewandroid: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.IconicsButtonandroid:text="{faw-adjust} Button"android:layout_width="120dp"android:layout_height="60dp"/>

Compose

implementation"com.mikepenz:iconics-compose:${latestAndroidIconicsRelease}"

Image(GoogleMaterial.Icon.gmd_access_alarm,    colorFilter=ColorFilter.tint(MaterialTheme.colors.primary),)

Screenshots

Available fonts

Compatibility Note

appcompat:1.4.x

app:emojiCompatEnabled="false"

Advanced Usage

Register fonts

classCustomApplication :Application() {overridefunonCreate() {super.onCreate()//register custom fonts like this (or also provide a font definition file)Iconics.registerFont(CustomFont())    }}

Advanced IconicsBuilder

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

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

IconicsDrawable(this,FontAwesome.Icon.faw_adjust).apply {    sizeDp=24    paddingDp=1}

Create custom fonts

String fields for icons

Android module generator

ProGuard / R8

Special Contributor

Credits

Developed By

License

Copyright 2021 Mike PenzLicensed 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.