Merge pull request #1 from lazycoder-21/font_awesome_icon

ankitk77 · web-flow · commit 440769bc43fc · 2022-05-26T23:45:07.000+05:30
Font awesome icon
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/README.md b/README.md
@@ -7,12 +7,31 @@ repositories {
 ```
 
 Now in build.gradle -> <br/>
-
-<li>
- font awesome icon, for more detail switch to `font_awesome_icon` branch 
-</li>
-
 ```
 com.github.lostankit7:androidCustomView:font_awesome_icon_v1.1
 ```
 
+To use font awesome icon through XML 
+
+```
+  <lostankit7.droid.customview.FontAwesomeIcon
+        android:id="@+id/textView"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_centerInParent="true"
+        android:gravity="center"
+        android:padding="10dp"
+        android:text="\uf058"
+        android:textColor="@color/purple_200"
+        android:textSize="25sp"
+        app:background_circular="true"
+        app:background_color="@color/white"
+        app:corner_radius="10dp"
+        android:clickable="true"
+        app:icon_type="fa_solid"
+        app:show_ripple="true"
+        app:show_stroke="true"
+        app:stroke_color="#A5B439"
+        app:stroke_width="1dp" />
+
+```
diff --git a/app/build.gradle b/app/build.gradle
@@ -34,5 +34,5 @@ android {
 dependencies {
 
     implementation 'androidx.appcompat:appcompat:1.4.1'
-    //implementation project(path: ':customView')
+    implementation project(path: ':customView')
 }
diff --git a/app/src/main/java/lostankit7/droid/androidcustomview/MainActivity.kt b/app/src/main/java/lostankit7/droid/androidcustomview/MainActivity.kt
@@ -2,6 +2,7 @@ package lostankit7.droid.androidcustomview
 
 import android.os.Bundle
 import androidx.appcompat.app.AppCompatActivity
+import lostankit7.droid.customview.FontAwesomeIcon
 
 class MainActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
diff --git a/app/src/main/res/layout/activity_main.xml b/app/src/main/res/layout/activity_main.xml
@@ -6,13 +6,24 @@
     android:layout_height="match_parent"
     tools:context=".MainActivity">
 
-    <TextView
+    <lostankit7.droid.customview.FontAwesomeIcon
         android:id="@+id/textView"
-        android:layout_width="100dp"
-        android:gravity="center"
-        android:textColor="@color/white"
-        android:layout_height="50dp"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
         android:layout_centerInParent="true"
-        android:text="Hello World!" />
+        android:gravity="center"
+        android:padding="10dp"
+        android:text="\uf058"
+        android:textColor="@color/purple_200"
+        android:textSize="25sp"
+        app:background_circular="true"
+        app:background_color="@color/white"
+        app:corner_radius="10dp"
+        android:clickable="true"
+        app:icon_type="fa_solid"
+        app:show_ripple="true"
+        app:show_stroke="true"
+        app:stroke_color="#A5B439"
+        app:stroke_width="1dp" />
 
 </RelativeLayout>
diff --git a/customView/build.gradle b/customView/build.gradle
@@ -45,7 +45,7 @@ afterEvaluate {
                 from components.release
 
                 groupId = 'com.github.lostankit7'
-                artifactId = ''
+                artifactId = 'font-aweomse-icon'
                 version = '1.1'
             }
         }
diff --git a/customView/src/main/assets/fonts/FaRegular5.ttf b/customView/src/main/assets/fonts/FaRegular5.ttf
diff --git a/customView/src/main/assets/fonts/FaSolid5.ttf b/customView/src/main/assets/fonts/FaSolid5.ttf
diff --git a/customView/src/main/java/lostankit7/droid/customview/FontAwesomeIcon.kt b/customView/src/main/java/lostankit7/droid/customview/FontAwesomeIcon.kt
@@ -0,0 +1,66 @@
+package lostankit7.droid.customview
+
+import android.content.Context
+import android.content.res.TypedArray
+import android.util.AttributeSet
+import androidx.appcompat.widget.AppCompatTextView
+import lostankit7.droid.utils.*
+import lostankit7.droid.utils.DEF_BG_CIRCULAR
+import lostankit7.droid.utils.DEF_CORNER_RADIUS
+import lostankit7.droid.utils.NO_COLOR
+
+/**
+ * @property p change fontawesome icon type : from xml [icon_type] or updateTypeface(@FontAwesomeIconType),
+ * border properties - [show_stroke] , [stroke_width], [stroke_color],
+ * ripple effect on click - [show_ripple], [ripple_color], [mask_color],
+ * background properties - [background_color] , [background_circular], [corner_radius]
+ * @author AnkitKumar
+ */
+class FontAwesomeIcon
+@JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) :
+    AppCompatTextView(context, attrs, defStyleAttr) {
+
+    init {
+        text = "\uf058"
+        val arr = context.obtainStyledAttributes(attrs, R.styleable.FontAwesomeIcon)
+        manageAttributes(arr)
+        arr.recycle()
+    }
+
+    private fun manageAttributes(arr: TypedArray) = with(arr) {
+
+        try {
+            updateTypeface(
+                getInt(R.styleable.FontAwesomeIcon_icon_type, FontAwesomeIconType.REGULAR)
+            )
+
+            val bgColor = getColor(R.styleable.FontAwesomeIcon_background_color, NO_COLOR)
+
+            val isBgCircular =
+                getBoolean(R.styleable.FontAwesomeIcon_background_circular, DEF_BG_CIRCULAR)
+            val cornerRadius =
+                getDimension(R.styleable.FontAwesomeIcon_corner_radius, DEF_CORNER_RADIUS)
+
+            val setStroke = getBoolean(R.styleable.FontAwesomeIcon_show_stroke, DEF_SET_STROKE)
+            val strokeWidth =
+                getDimension(R.styleable.FontAwesomeIcon_stroke_width, DEF_STROKE_WIDTH)
+            val strokeColor = getColor(R.styleable.FontAwesomeIcon_stroke_color, DEF_STROKE_COLOR)
+
+            val showRipple = getBoolean(R.styleable.FontAwesomeIcon_show_ripple, DEF_SHOW_RIPPLE)
+            val rippleColor = getColor(R.styleable.FontAwesomeIcon_ripple_color, DEF_RIPPLE_COLOR)
+            val maskColor = getColor(R.styleable.FontAwesomeIcon_mask_color, DEF_MASK_COLOR)
+
+            if(!setStroke && !showRipple) return@with
+
+            if (isBgCircular) setCircularBackground(
+                bgColor, strokeColor, strokeWidth, showRipple, rippleColor, maskColor
+            ) else
+                setCustomBackground(
+                    bgColor, cornerRadius, strokeColor, strokeWidth,
+                    showRipple, rippleColor, maskColor
+                )
+
+        } catch (e: Exception) {
+        }
+    }
+}
diff --git a/customView/src/main/java/lostankit7/droid/customview/FontAwesomeIconType.kt b/customView/src/main/java/lostankit7/droid/customview/FontAwesomeIconType.kt
@@ -0,0 +1,13 @@
+package lostankit7.droid.customview
+
+import androidx.annotation.IntDef
+
+@IntDef(FontAwesomeIconType.REGULAR, FontAwesomeIconType.SOLID, FontAwesomeIconType.BRAND)
+        @Retention(AnnotationRetention.SOURCE)
+        annotation class FontAwesomeIconType {
+            companion object {
+                const val REGULAR = 0
+                const val SOLID = 1
+                const val BRAND = 2
+            }
+        }
diff --git a/customView/src/main/java/lostankit7/droid/customview/FontCache.kt b/customView/src/main/java/lostankit7/droid/customview/FontCache.kt
@@ -0,0 +1,26 @@
+package lostankit7.droid.customview
+
+import android.content.Context
+import android.graphics.Typeface
+import java.util.*
+
+object FontCache {
+        const val faBrandIcon = "fonts/FaBrand5.ttf"
+        const val faSolidIcon = "fonts/FaSolid5.ttf"
+        const val faRegularIcon = "fonts/FaRegular5.ttf"
+
+        private val fontCache: Hashtable<String, Typeface> = Hashtable()
+
+        operator fun get(context: Context, name: String?): Typeface? {
+            var typeface: Typeface? = fontCache[name]
+            if (typeface == null) {
+                typeface = try {
+                    Typeface.createFromAsset(context.assets, name)
+                } catch (e: Exception) {
+                    return null
+                }
+                fontCache[name] = typeface
+            }
+            return typeface
+        }
+    }
diff --git a/customView/src/main/java/lostankit7/droid/utils/ResourceExt.kt b/customView/src/main/java/lostankit7/droid/utils/ResourceExt.kt
@@ -9,13 +9,13 @@ import android.graphics.drawable.shapes.RoundRectShape
 import android.util.TypedValue
 import java.util.*
 
-fun Float.toDp(resources: Resources) = TypedValue.applyDimension(
+internal fun Float.toDp(resources: Resources) = TypedValue.applyDimension(
     TypedValue.COMPLEX_UNIT_DIP, this, resources.displayMetrics
 )
 
-fun Int.colorStateList() = ColorStateList.valueOf(this)
+internal fun Int.colorStateList() = ColorStateList.valueOf(this)
 
-fun Int.getRippleMask(radius: Float): Drawable {
+internal fun Int.getRippleMask(radius: Float): Drawable {
     val radiusArray = FloatArray(8)
     Arrays.fill(radiusArray, radius)
     val shape = RoundRectShape(radiusArray, null, null)
@@ -24,7 +24,7 @@ fun Int.getRippleMask(radius: Float): Drawable {
     return shapeDrawable
 }
 
-fun Int.getCircularRippleMask(): Drawable {
+internal fun Int.getCircularRippleMask(): Drawable {
     val shape = OvalShape()
     val shapeDrawable = ShapeDrawable(shape)
     shapeDrawable.paint.color = this
diff --git a/customView/src/main/java/lostankit7/droid/utils/Utils.kt b/customView/src/main/java/lostankit7/droid/utils/Utils.kt
@@ -1,16 +1,27 @@
 package lostankit7.droid.utils
 
 import android.graphics.Color
+import android.widget.TextView
+import lostankit7.droid.customview.FontAwesomeIconType
+import lostankit7.droid.customview.FontCache
 
 internal const val NO_COLOR = Color.TRANSPARENT
 
 internal const val DEF_CORNER_RADIUS = 8f
-internal const val DEF_BG_CIRCULAR = false
+internal const val DEF_BG_CIRCULAR = true
 
 internal const val DEF_SET_STROKE = false
 internal const val DEF_STROKE_COLOR = Color.BLUE
 internal const val DEF_STROKE_WIDTH = 3f
 
 internal const val DEF_SHOW_RIPPLE = false
 internal const val DEF_RIPPLE_COLOR = Color.LTGRAY
-internal const val DEF_MASK_COLOR = Color.GRAY
+internal const val DEF_MASK_COLOR = Color.GRAY
+
+fun TextView.updateTypeface(@FontAwesomeIconType iconType: Int) {
+    typeface = when (iconType) {
+        FontAwesomeIconType.BRAND -> FontCache[context, FontCache.faBrandIcon]
+        FontAwesomeIconType.SOLID -> FontCache[context, FontCache.faSolidIcon]
+        else -> FontCache[context, FontCache.faRegularIcon]
+    }
+}
diff --git a/customView/src/main/res/values/attrs.xml b/customView/src/main/res/values/attrs.xml
@@ -1,20 +1,26 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
-    <declare-styleable name="ParentStyleable">
+    <declare-styleable name="FontAwesomeIcon">
+
+        <attr name="icon_type" format="enum">
+            <enum name="fa_regular" value="0" />
+            <enum name="fa_solid" value="1" />
+            <enum name="fa_brand" value="2" />
+        </attr>
 
-        <!-- Gradient start and end color -->
-        <attr name="start_color" format="color" />
-        <attr name="end_color" format="color" />
         <attr name="background_color" format="color" />
 
-        <!-- stroke / border attrs i.e., width, color, radius -->
+        <!-- to show or hide border or stroke-->
+        <attr name="show_stroke" format="boolean" />
         <attr name="stroke_width" format="dimension" />
         <attr name="stroke_color" format="color" />
 
         <attr name="corner_radius" format="dimension" />
+
+        <!-- if you want background to be circular make sure view's height and width are same -->
         <attr name="background_circular" format="boolean" />
 
-        <!-- for ripple effect -->
+        <!-- to show or hide ripple effect on click of the icon -->
         <attr name="ripple_color" format="color" />
         <attr name="mask_color" format="color" />
         <attr name="show_ripple" format="boolean" />
diff --git a/customView/src/main/res/values/dimens.xml b/customView/src/main/res/values/dimens.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <dimen name="dp_3">3dp</dimen>
+</resources>

Original file line number	Diff line number	Diff line change
`@@ -34,5 +34,5 @@ android {`
`34`	`34`	`dependencies {`
`35`	`35`
`36`	`36`	`implementation 'androidx.appcompat:appcompat:1.4.1'`
`37`		`- //implementation project(path: ':customView')`
	`37`	`+ implementation project(path: ':customView')`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ afterEvaluate {`
`45`	`45`	`from components.release`
`46`	`46`
`47`	`47`	`groupId = 'com.github.lostankit7'`
`48`		`- artifactId = ''`
	`48`	`+ artifactId = 'font-aweomse-icon'`
`49`	`49`	`version = '1.1'`
`50`	`50`	`}`
`51`	`51`	`}`