Add styling options for delete button (#43)

Author: davidmigloz

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## Version 4.0.7  *(15/06/2024)*
+
+- Added `iconTint` and `colors` parameters to `NumberKeyboardAuxButton` to allow
+  customization of delete button color and styling
+
 ## Version 4.0.6  *(07/03/2024)*
 
 - Downgrade to Java 18

README.md

@@ -25,7 +25,7 @@ Add the dependency:
 
 ```gradle
 dependencies {
-	implementation 'com.github.davidmigloz:number-keyboard:4.0.6'
+        implementation 'com.github.davidmigloz:number-keyboard:4.0.7'
 }
 ```
 
@@ -63,6 +63,7 @@ NumberKeyboard(
       modifier = buttonModifier,
       textStyle = buttonTextStyle,
       imageVector = Icons.Rounded.Backspace,
+      iconTint = MaterialTheme.colorScheme.primary,
       clicked = { clickedListener.onRightAuxButtonClicked() }
     )
   },
@@ -141,6 +142,25 @@ fun NumberKeyboardButton(
 }
 ```
 
+`NumberKeyboardAuxButton` provides the default look for the auxiliary keys. It
+now accepts `colors` and `iconTint` so you can customise the delete button and
+other icons:
+
+```kotlin
+@Composable
+fun NumberKeyboardAuxButton(
+    modifier: Modifier,
+    textStyle: TextStyle,
+    shape: Shape = RoundedCornerShape(size = 8.dp),
+    haptics: HapticFeedback = LocalHapticFeedback.current,
+    value: String? = null,
+    imageVector: ImageVector? = null,
+    clicked: () -> Unit,
+    colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
+    iconTint: Color = LocalContentColor.current
+)
+```
+
 ##### NumberKeyboardListener
 
 This listener is _optional_, but if you want to utilise this. Make sure that the `NumberKeyboardClickedListener` is configured properly when you are building your button layouts.

lib/build.gradle

@@ -6,7 +6,7 @@ plugins {
 ext {
     versionMajor = 4 // API Changes, adding big new feature, redesign the App
     versionMinor = 0 // New features in a backwards-compatible manner
-    versionPatch = 6 // Backwards-compatible bug fixes
+    versionPatch = 7 // Backwards-compatible bug fixes
     versionClassifier = null // Pre-releases (alpha, beta, rc, SNAPSHOT...)
 }
 

lib/src/main/java/com/davidmiguel/numberkeyboard/NumberKeyboardButton.kt

@@ -5,16 +5,20 @@ import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.RowScope
 import androidx.compose.foundation.layout.Spacer
 import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material3.ButtonColors
+import androidx.compose.material3.ButtonDefaults
 import androidx.compose.material3.OutlinedButton
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.ColorFilter
 import androidx.compose.ui.graphics.Shape
 import androidx.compose.ui.graphics.vector.ImageVector
 import androidx.compose.ui.hapticfeedback.HapticFeedback
 import androidx.compose.ui.hapticfeedback.HapticFeedbackType
 import androidx.compose.ui.platform.LocalHapticFeedback
+import androidx.compose.ui.platform.LocalContentColor
 import androidx.compose.ui.text.TextStyle
 import androidx.compose.ui.unit.dp
 import com.davidmiguel.numberkeyboard.listener.NumberKeyboardClickedListener
@@ -44,6 +48,19 @@ fun NumberKeyboardButton(
     }
 }
 
+/**
+ * Default auxiliary button for [NumberKeyboard]. Can display either text or an icon.
+ *
+ * @param modifier button modifier
+ * @param textStyle style applied to [value] text
+ * @param shape button shape
+ * @param haptics haptic feedback implementation
+ * @param value optional text displayed inside the button
+ * @param imageVector optional icon displayed when [value] is null or blank
+ * @param clicked callback invoked when the button is clicked
+ * @param colors customizable [ButtonColors] for the button
+ * @param iconTint tint applied to [imageVector]
+ */
 @Composable
 fun NumberKeyboardAuxButton(
     modifier: Modifier,
@@ -52,13 +69,16 @@ fun NumberKeyboardAuxButton(
     haptics: HapticFeedback = LocalHapticFeedback.current,
     value: String? = null,
     imageVector: ImageVector? = null,
-    clicked: () -> Unit
+    clicked: () -> Unit,
+    colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
+    iconTint: Color = LocalContentColor.current
 ) {
     if (value.isNullOrBlank() && imageVector == null) return
     OutlinedButton(
         modifier = modifier,
         shape = shape,
         border = BorderStroke(1.dp, Color.LightGray),
+        colors = colors,
         onClick = {
             haptics.performHapticFeedback(HapticFeedbackType.LongPress)
             clicked.invoke()
@@ -72,7 +92,8 @@ fun NumberKeyboardAuxButton(
         } else if (imageVector != null) {
             Image(
                 imageVector = imageVector,
-                contentDescription = imageVector.name
+                contentDescription = imageVector.name,
+                colorFilter = ColorFilter.tint(iconTint)
             )
         }
     }
@@ -81,4 +102,4 @@ fun NumberKeyboardAuxButton(
 @Composable
 fun RowScope.NumberKeyboardBlank() {
     Spacer(modifier = Modifier.weight(1F))
-}
+}