Update README.md

Author: davidmigloz

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Change Log
 
-## Version 4.0.0  *(XX/XX/2023)*
+## Version 4.0.0  *(03/11/2023)*
 
-- Revamped Number Keyboard to Compose #37
+- Revamped Number Keyboard to Compose #37 (thanks @delacrixmorgan!)
 
 ## Version 3.1.0  *(13/12/2022)*
 

README.md

@@ -1,6 +1,6 @@
 # Number Keyboard  [![](https://jitpack.io/v/davidmigloz/number-keyboard.svg)](https://jitpack.io/#davidmigloz/number-keyboard)
 
-Android library that provides a number keyboard view.
+Android library that provides a number keyboard composable.
 
 ![screenshot](img/screenshot.jpg)
 
@@ -33,73 +33,43 @@ dependencies {
 
 #### Step 3
 
-Use `NumberKeyboard` view in your layout:
-
-```xml
-<com.davidmiguel.numberkeyboard.NumberKeyboard
-    xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:keyboard="http://schemas.android.com/apk/res-auto"
-    ...
-    keyboard:numberkeyboard_keyboardType="integer"
-    ... />
-```
-
-#### Attributes
-
-- `keyboard:numberkeyboard_keyboardType="[integer|decimal|fingerprint|custom]"` (required): defines the type of keyboard.
-  - `integer`: numbers and backspace keys.
-  - `decimal`: numbers, comma and backspace keys.
-  - `fingerprint`: numbers, fingerprint and backspace keys.
-  - `custom`: numbers and defined auxiliary keys.
-- `keyboard:numberkeyboard_keyWidth="[dimension]"` (default: `match_parent`): key width (`wrap_content` not allowed).
-- `keyboard:numberkeyboard_keyHeight="[dimension]"` (default: `match_parent`): key height (`wrap_content` not allowed).
-- `keyboard:numberkeyboard_keyPadding="[dimension]"` (default: `16dp`): key padding.
-- `keyboard:numberkeyboard_numberKeyBackground="[reference]"` (default: circle): number keys background drawable.
-- `keyboard:numberkeyboard_numberKeyTextColor="[reference]"` (default: dark blue): number keys text color.
-- `keyboard:numberkeyboard_numberKeyTypeface="[reference]"` (default: dark blue): number keys text color.
-- `keyboard:numberkeyboard_numberKeyTypeface="[reference]"` (default: none): number keys text typeface.
-- `keyboard:numberkeyboard_numberKeyTextSize="[dimension]"` (default: none): number keys text size (if it is not set, the text auto scales to fit the key).
-- `keyboard:numberkeyboard_leftAuxBtnBackground="[reference]"` (default: none): if `keyboardType="custom"`, left auxiliary button background.
-- `keyboard:numberkeyboard_rightAuxBtnIcon="[reference]"` (default: none): if `keyboardType="custom"`, icon shown in right auxiliary button.
-- `keyboard:numberkeyboard_rightAuxBtnBackground="[reference]"` (default: none): if `keyboardType="custom"`, right auxiliary button background.
-
-#### Methods
-
-- `hideLeftAuxButton()`: hides left auxiliary button.
-- `showLeftAuxButton()`: shows left auxiliary button.
-- `hideRightAuxButton()`: hides right auxiliary button.
-- `showRightAuxButton()`: shows right auxiliary button.
-- `setKeyWidth()`: sets key width in px.
-- `setKeyHeight()`: sets key height in px.
-- `setKeyPadding()`: sets key padding in px.
-- `setNumberKeyBackground()`: sets number keys background.
-- `setNumberKeyTextColor()`: sets number keys text color.
-- `setNumberKeyTypeface()`: sets number keys text typeface.
-- `setNumberKeyTextSize()`: sets number keys text size in pixels.
-- `setLeftAuxButtonIcon()`: sets left auxiliary button icon.
-- `setRightAuxButtonIcon()`: sets right auxiliary button icon.
-- `setLeftAuxButtonBackground()`: sets left auxiliary button background.
-- `setRightAuxButtonBackground()`: sets right auxiliary button background.
-
-#### Callback
-
-To listen to keyboard events, you have to use `NumberKeyboardListener`:
-
-- `onNumberClicked()`: invoked when a number key is clicked.
-- `onLeftAuxButtonClicked()`: invoked when the left auxiliary button is clicked.
-- `onRightAuxButtonClicked()`: invoked when the right auxiliary button is clicked.
-
-```java
-numberKeyboard.setListener(new NumberKeyboardListener() {
-     @Override
-     public void onNumberClicked(int number) {...}
-
-     @Override
-     public void onLeftAuxButtonClicked() {...}
-
-     @Override
-     public void onRightAuxButtonClicked() {...}
-});
+Use `NumberKeyboard` composable in your layout:
+
+```kotlin
+NumberKeyboard(
+  maxAllowedAmount = 999.00,
+  maxAllowedDecimals = 0,
+  roundUpToMax = false,
+  button = { number, clickedListener ->
+    NumberKeyboardButton(
+      modifier = buttonModifier,
+      textStyle = buttonTextStyle,
+      number = number,
+      listener = clickedListener
+    )
+  },
+  leftAuxButton = { _ ->
+    NumberKeyboardAuxButton(
+      modifier = buttonModifier,
+      textStyle = buttonTextStyle,
+      imageVector = Icons.Rounded.Fingerprint,
+      clicked = { Toast.makeText(context, "Triggered", Toast.LENGTH_SHORT).show() }
+    )
+  },
+  rightAuxButton = { clickedListener ->
+    NumberKeyboardAuxButton(
+      modifier = buttonModifier,
+      textStyle = buttonTextStyle,
+      imageVector = Icons.Rounded.Backspace,
+      clicked = { clickedListener.onRightAuxButtonClicked() }
+    )
+  },
+  listener = object : NumberKeyboardListener {
+    override fun onUpdated(data: NumberKeyboardData) {
+      text = data.int.toString()
+    }
+  }
+)
 ```
 
 Take a look at the [sample app](https://github.com/davidmigloz/number-keyboard/tree/master/sample) to see the library working.
@@ -111,7 +81,7 @@ Pull request are very appreciated.
 
 ## License
 
-Copyright (c) 2023 David Miguel Lozano
+Copyright (c) 2023 David Miguel Lozano / Morgan Koh
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.