ユーザーが入力するときに入力を検証する

ユーザーがテキストフィールドに入力する際に、入力内容を検証できます。たとえば、名前、メールアドレス、住所、その他の連絡先情報を入力する際に検証できます。この検証により、エラーを減らし、ユーザーの時間を節約できます。

結果

有効なテキスト入力 — **図 1.**有効なメールアドレスが入力されたときにエラーメッセージが表示されない、メール検証ツール付きのテキスト入力フィールド。

エラーを含む無効なテキスト入力 — **図 2.**無効なメールアドレスが入力されたときにエラーメッセージが表示されるテキスト入力フィールド。

バージョンの互換性

この実装では、プロジェクトの minSDK を API レベル 21 以上に設定する必要があります。

依存関係

ユーザーが入力する際に検証する

次のコードを使用して、フィールド入力を表示し、ユーザーが入力する際にテキストを検証します。情報が検証されない場合は、エラーメッセージが表示され、ユーザーが入力内容を修正できます。

class EmailViewModel : ViewModel() {
    var email by mutableStateOf("")
        private set

    val emailHasErrors by derivedStateOf {
        if (email.isNotEmpty()) {
            // Email is considered erroneous until it completely matches EMAIL_ADDRESS.
            !android.util.Patterns.EMAIL_ADDRESS.matcher(email).matches()
        } else {
            false
        }
    }

    fun updateEmail(input: String) {
        email = input
    }
}

@Composable
fun ValidatingInputTextField(
    email: String,
    updateState: (String) -> Unit,
    validatorHasErrors: Boolean
) {
    OutlinedTextField(
        modifier = Modifier
            .fillMaxWidth()
            .padding(10.dp),
        value = email,
        onValueChange = updateState,
        label = { Text("Email") },
        isError = validatorHasErrors,
        supportingText = {
            if (validatorHasErrors) {
                Text("Incorrect email format.")
            }
        }
    )
}

@Preview
@Composable
fun ValidateInput() {
    val emailViewModel: EmailViewModel = viewModel<EmailViewModel>()
    ValidatingInputTextField(
        email = emailViewModel.email,
        updateState = { input -> emailViewModel.updateEmail(input) },
        validatorHasErrors = emailViewModel.emailHasErrors
    )
}TextSnippets.kt

コードに関する主なポイント

OutlinedTextField コンポーネントを再利用する Composable を定義し、バリデータエラーメッセージをユーザーが入力する際に表示するために必要なパラメータを追加します。
EmailViewModel は、状態を維持し、メール検証ロジックを提供するために使用されます。
isError が true の場合、UI に検証エラー状態の視覚的なインジケーターが表示されます。
完全で正しいメールが入力されるまで、コンポーネントに「メールの形式が正しくありません」と表示されます。