Skip to content

Make PlatformImeOptionsImpl a @Immutable data class #2413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 18, 2025
Merged

Make PlatformImeOptionsImpl a @Immutable data class #2413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9982e0d
Make PlatformImeOptionsImpl @Immutable data class to skip unnecessary…
svastven Sep 17, 2025
e0e5ba0
Add test to validate text input session retention when input changes
svastven Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...i/ui-text/src/uikitMain/kotlin/androidx/compose/ui/text/input/PlatformImeOptions.uikit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,19 @@

package androidx.compose.ui.text.input

import androidx.compose.runtime.Immutable
import androidx.compose.ui.ExperimentalComposeUiApi
import platform.UIKit.UIKeyboardAppearance
import platform.UIKit.UIKeyboardAppearanceDefault
import platform.UIKit.UIKeyboardType
import platform.UIKit.UIKeyboardTypeDefault
import platform.UIKit.UIReturnKeyType
import platform.UIKit.UITextAutocapitalizationType
import platform.UIKit.UITextAutocorrectionType
import platform.UIKit.UITextContentType
import platform.UIKit.UIView

private class PlatformImeOptionsImpl(
@Immutable
private data class PlatformImeOptionsImpl(
val keyboardType: UIKeyboardType?,
val keyboardAppearance: UIKeyboardAppearance,
val returnKeyType: UIReturnKeyType?,
Expand Down
68 changes: 65 additions & 3 deletions ...ose/ui/ui/src/uikitInstrumentedTest/kotlin/androidx/compose/ui/keyboard/ImeOptionsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,19 @@ package androidx.compose.ui.keyboard
import androidx.compose.foundation.text.KeyboardOptions
import androidx.compose.material.TextField
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.key
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.focus.FocusRequester
import androidx.compose.ui.focus.focusRequester
import androidx.compose.ui.platform.InterceptPlatformTextInput
import androidx.compose.ui.platform.PlatformTextInputMethodRequest
import androidx.compose.ui.platform.PlatformTextInputSession
import androidx.compose.ui.platform.testTag
import androidx.compose.ui.test.UIKitInstrumentedTest
import androidx.compose.ui.test.findNodeWithTag
import androidx.compose.ui.test.runUIKitInstrumentedTest
import androidx.compose.ui.text.input.ImeAction
import androidx.compose.ui.text.input.KeyboardCapitalization
Expand All @@ -38,6 +46,7 @@ import kotlin.test.assertSame
import kotlin.test.assertTrue
import kotlinx.cinterop.ExperimentalForeignApi
import kotlinx.cinterop.readValue
import kotlinx.coroutines.suspendCancellableCoroutine
import platform.CoreGraphics.CGRectZero
import platform.UIKit.UIInputView
import platform.UIKit.UIInputViewStyle
Expand All @@ -46,14 +55,14 @@ import platform.UIKit.UIKeyboardAppearanceDefault
import platform.UIKit.UIKeyboardTypeDefault
import platform.UIKit.UIKeyboardTypeEmailAddress
import platform.UIKit.UIKeyboardTypeURL
import platform.UIKit.UIResponder
import platform.UIKit.UIReturnKeyType
import platform.UIKit.UITextAutocapitalizationType
import platform.UIKit.UITextAutocorrectionType
import platform.UIKit.UITextContentTypeBirthdate
import platform.UIKit.UITextContentTypeEmailAddress
import platform.UIKit.UITextContentTypePassword
import platform.UIKit.UITextContentTypeTelephoneNumber
import platform.UIKit.UITextContentTypeUsername
import platform.UIKit.UITextInputProtocol
import platform.UIKit.UIView
import platform.UIKit.inputAccessoryView
Expand Down Expand Up @@ -383,7 +392,60 @@ internal class ImeOptionsTest {
assertSame(customInputAccessoryView, input.inputAccessoryView)
}

private fun UIKitInstrumentedTest.setContentAndFindInputView(keyboardOptions: KeyboardOptions): UIView {
@OptIn(ExperimentalForeignApi::class)
@Test
fun testTextInputSessionDoesNotRestartWithChangedInput() = runUIKitInstrumentedTest {
val inputState = mutableStateOf("")
var startInputCount = 0

val testTextInputSession = object : PlatformTextInputSession {
override suspend fun startInputMethod(
request: PlatformTextInputMethodRequest
): Nothing {
startInputCount++
suspendCancellableCoroutine<Nothing> { }
}
}

setContent {
var input by rememberSaveable { inputState }

InterceptPlatformTextInput(
interceptor = { request, _ ->
testTextInputSession.startInputMethod(request)
},
content = {
TextField(
modifier = Modifier.testTag("TextField"),
value = input,
onValueChange = { input = it },
keyboardOptions = KeyboardOptions(platformImeOptions = PlatformImeOptions {
keyboardType(UIKeyboardTypeEmailAddress)
textContentType(UITextContentTypeUsername)
})
)
}
)
}

findNodeWithTag("TextField").tap()

waitForIdle()

assertEquals(1, startInputCount)

var input = ""
for (i in 1..4) {
input += "$i"
inputState.value = input
waitForIdle()
assertEquals(1, startInputCount)
}
}

private fun UIKitInstrumentedTest.setContentAndFindInputView(
keyboardOptions: KeyboardOptions
): UIView {
val focusRequester = FocusRequester()

setContent {
Expand Down