Add possibility to change imeAction for OTP view (#44)

Danielekeller · tarikyasar · commit 481dc1ff3cdd · 2025-09-16T16:48:49.000+03:00
Add ime action and callbacks
diff --git a/ohteepee/src/androidTest/java/com/composeuisuite/ohteepee/helpers/TestUtil.kt b/ohteepee/src/androidTest/java/com/composeuisuite/ohteepee/helpers/TestUtil.kt
@@ -1,5 +1,5 @@
 package com.composeuisuite.ohteepee.helpers
 
-fun sleepThreadToSeeUiTestResults(){
+fun sleepThreadToSeeUiTestResults() {
     Thread.sleep(1000)
-}
+}
diff --git a/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeCell.kt b/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeCell.kt
@@ -29,6 +29,7 @@ import androidx.compose.ui.graphics.SolidColor
 import androidx.compose.ui.input.key.Key
 import androidx.compose.ui.input.key.key
 import androidx.compose.ui.input.key.onPreviewKeyEvent
+import androidx.compose.ui.platform.SoftwareKeyboardController
 import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.text.TextStyle
 import androidx.compose.ui.text.input.ImeAction
@@ -54,11 +55,19 @@ internal fun OhTeePeeCell(
     value: String,
     onValueChange: (String) -> Unit,
     keyboardType: KeyboardType,
+    imeAction: ImeAction,
+    keyboardController: SoftwareKeyboardController?,
     configurations: OhTeePeeConfigurations,
     placeHolder: String,
     visualTransformation: VisualTransformation,
     isErrorOccurred: Boolean,
     enabled: Boolean,
+    callbackOnNext: () -> Unit,
+    callbackOnDone: () -> Unit,
+    callbackOnPrevious: () -> Unit,
+    callbackOnSearch: () -> Unit,
+    callbackOnSend: () -> Unit,
+    callbackOnGo: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
     var isFocused by remember { mutableStateOf(false) }
@@ -138,13 +147,29 @@ internal fun OhTeePeeCell(
                 .cellBackground(cellConfiguration.cellBackground)
                 .testTag(OH_TEE_PEE_CELL_TEST_TAG),
             keyboardOptions = KeyboardOptions(
+                autoCorrectEnabled = false,
                 keyboardType = keyboardType,
-                imeAction = ImeAction.Next,
-                autoCorrect = false,
+                imeAction = imeAction,
             ),
             keyboardActions = KeyboardActions(
-                onNext = {},
-                onDone = {},
+                onNext = {
+                    callbackOnNext()
+                },
+                onDone = {
+                    callbackOnDone()
+                },
+                onPrevious = {
+                    callbackOnPrevious()
+                },
+                onSearch = {
+                    callbackOnSearch()
+                },
+                onSend = {
+                    callbackOnSend()
+                },
+                onGo = {
+                    callbackOnGo()
+                },
             ),
             singleLine = true,
             enabled = enabled,
diff --git a/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeDefaults.kt b/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeDefaults.kt
@@ -94,4 +94,4 @@ object OhTeePeeDefaults {
         textStyle = textStyle,
         placeHolderTextStyle = placeHolderTextStyle,
     )
-}
+}
diff --git a/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeInput.kt b/ohteepee/src/main/java/com/composeuisuite/ohteepee/OhTeePeeInput.kt
@@ -24,6 +24,8 @@ import androidx.compose.ui.graphics.Color.Companion.Transparent
 import androidx.compose.ui.graphics.graphicsLayer
 import androidx.compose.ui.platform.LocalFocusManager
 import androidx.compose.ui.platform.LocalLayoutDirection
+import androidx.compose.ui.platform.SoftwareKeyboardController
+import androidx.compose.ui.text.input.ImeAction
 import androidx.compose.ui.text.input.KeyboardType
 import androidx.compose.ui.text.input.PasswordVisualTransformation
 import androidx.compose.ui.text.input.VisualTransformation
@@ -87,7 +89,15 @@ fun OhTeePeeInput(
     modifier: Modifier = Modifier,
     isValueInvalid: Boolean = false,
     keyboardType: KeyboardType = KeyboardType.NumberPassword,
+    imeAction: ImeAction = ImeAction.Next,
+    callbackOnNext: () -> Unit = {},
+    callbackOnDone: () -> Unit = {},
+    callbackOnPrevious: () -> Unit = {},
+    callbackOnSearch: () -> Unit = {},
+    callbackOnSend: () -> Unit = {},
+    callbackOnGo: () -> Unit = {},
     enabled: Boolean = true,
+    keyboardController: SoftwareKeyboardController? = null,
     autoFocusByDefault: Boolean = true,
     horizontalArrangement: Arrangement.Horizontal = Arrangement.Start,
     layoutDirection: LayoutDirection = LocalLayoutDirection.current,
@@ -201,6 +211,14 @@ fun OhTeePeeInput(
                 moveFocus = ::moveFocus,
             )
         },
+        imeAction = imeAction,
+        callbackOnNext = callbackOnNext,
+        callbackOnDone = callbackOnDone,
+        callbackOnPrevious = callbackOnPrevious,
+        callbackOnSearch = callbackOnSearch,
+        callbackOnSend = callbackOnSend,
+        callbackOnGo = callbackOnGo,
+        keyboardController = keyboardController,
     )
 }
 
@@ -233,13 +251,21 @@ private fun OhTeePeeInput(
     placeHolder: String,
     isErrorOccurred: Boolean,
     keyboardType: KeyboardType,
+    imeAction: ImeAction,
     ohTeePeeConfigurations: OhTeePeeConfigurations,
     focusRequesters: List<FocusRequester>,
     enabled: Boolean,
     visualTransformation: VisualTransformation,
     onCellInputChange: (index: Int, value: String) -> Unit,
     horizontalArrangement: Arrangement.Horizontal,
     layoutDirection: LayoutDirection,
+    callbackOnNext: () -> Unit,
+    callbackOnDone: () -> Unit,
+    callbackOnPrevious: () -> Unit,
+    callbackOnSearch: () -> Unit,
+    callbackOnSend: () -> Unit,
+    callbackOnGo: () -> Unit,
+    keyboardController: SoftwareKeyboardController? = null,
     divider: @Composable (RowScope.(cellIndex: Int) -> Unit)?,
 ) {
     CompositionLocalProvider(
@@ -267,6 +293,14 @@ private fun OhTeePeeInput(
                     onValueChange = { onCellInputChange(index, it) },
                     placeHolder = placeHolder,
                     visualTransformation = visualTransformation,
+                    imeAction = imeAction,
+                    callbackOnNext = callbackOnNext,
+                    callbackOnDone = callbackOnDone,
+                    callbackOnPrevious = callbackOnPrevious,
+                    callbackOnSearch = callbackOnSearch,
+                    callbackOnSend = callbackOnSend,
+                    callbackOnGo = callbackOnGo,
+                    keyboardController = keyboardController,
                 )
                 if (divider != null && index != cellsCount - 1) {
                     divider(index)
@@ -336,4 +370,4 @@ private fun handleCellInputChange(
 
 private fun getCellDisplayCharacter(
     currentChar: Char,
-): String = if (currentChar == NOT_ENTERED_VALUE) String.EMPTY else currentChar.toString()
+): String = if (currentChar == NOT_ENTERED_VALUE) String.EMPTY else currentChar.toString()
diff --git a/ohteepee/src/main/java/com/composeuisuite/ohteepee/configuration/OhTeePeeErrorAnimationConfig.kt b/ohteepee/src/main/java/com/composeuisuite/ohteepee/configuration/OhTeePeeErrorAnimationConfig.kt
@@ -17,4 +17,3 @@ sealed class OhTeePeeErrorAnimationConfig {
         val animationSpec: AnimationSpec<Float> = OhTeePeeDefaults.defaultShakeAnimationSpec,
     ) : OhTeePeeErrorAnimationConfig()
 }
-
diff --git a/ohteepee/src/main/java/com/composeuisuite/ohteepee/example/BasicOhTeePeeExample.kt b/ohteepee/src/main/java/com/composeuisuite/ohteepee/example/BasicOhTeePeeExample.kt
@@ -10,7 +10,9 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.platform.LocalSoftwareKeyboardController
 import androidx.compose.ui.text.TextStyle
+import androidx.compose.ui.text.input.ImeAction
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import com.composeuisuite.ohteepee.OhTeePeeDefaults
@@ -30,6 +32,8 @@ internal fun BasicOhTeePeeExample() {
         ),
     )
 
+    val keyboardController = LocalSoftwareKeyboardController.current
+
     OhTeePeeInput(
         value = otpValue,
         onValueChange = { newValue, isValid ->
@@ -55,6 +59,16 @@ internal fun BasicOhTeePeeExample() {
             placeHolder = "-",
             cellModifier = Modifier.size(48.dp),
         ),
+        imeAction = ImeAction.Done,
+        callbackOnNext = {},
+        callbackOnDone = {
+            keyboardController?.hide()
+        },
+        callbackOnPrevious = {},
+        callbackOnSearch = {},
+        callbackOnSend = {},
+        callbackOnGo = {},
+        keyboardController = keyboardController,
     )
 }
 
diff --git a/sample/src/main/java/com/composeuisuite/ohteepee/MainActivity.kt b/sample/src/main/java/com/composeuisuite/ohteepee/MainActivity.kt
@@ -43,9 +43,11 @@ import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.RadialGradientShader
 import androidx.compose.ui.graphics.Shader
 import androidx.compose.ui.graphics.ShaderBrush
+import androidx.compose.ui.platform.LocalSoftwareKeyboardController
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.text.TextStyle
 import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.input.ImeAction
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.text.style.TextDecoration
 import androidx.compose.ui.unit.dp
@@ -110,6 +112,7 @@ class MainActivity : ComponentActivity() {
 
 @Composable
 private fun Sample0(modifier: Modifier = Modifier) {
+    val keyboardController = LocalSoftwareKeyboardController.current
     val backgroundColor = Color(0xFF4F4F83)
     val cellBackgroundColor = Color(0xFFFFE09A).copy(alpha = 0.2f)
     var otpValue: String by remember { mutableStateOf("") }
@@ -177,7 +180,12 @@ private fun Sample0(modifier: Modifier = Modifier) {
                     translationXRange = 5f,
                 ),
             ),
+            imeAction = ImeAction.Done,
             autoFocusByDefault = false,
+            keyboardController = keyboardController,
+            callbackOnDone = {
+                keyboardController?.hide()
+            },
         )
 
         Spacer(modifier = Modifier.height(64.dp))

Original file line number	Diff line number	Diff line change
`@@ -94,4 +94,4 @@ object OhTeePeeDefaults {`
`94`	`94`	`textStyle = textStyle,`
`95`	`95`	`placeHolderTextStyle = placeHolderTextStyle,`
`96`	`96`	`)`
`97`		`-}`
	`97`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,3 @@ sealed class OhTeePeeErrorAnimationConfig {`
`17`	`17`	`val animationSpec: AnimationSpec<Float> = OhTeePeeDefaults.defaultShakeAnimationSpec,`
`18`	`18`	`) : OhTeePeeErrorAnimationConfig()`
`19`	`19`	`}`
`20`		`-`