[androidx.compose.foundation.text] class KeyboardOptions 정리

class KeyboardOptions

TextFields에 대한 키보드 구성 옵션입니다.

소프트웨어 키보드가 여기에 제공된 옵션을 준수하는지 여부는 보장되지 않습니다.

Summary

Public companion properties

KeyboardOptions

Default Default KeyboardOptions.

Protected companion properties

KeyboardOptions

Default Default KeyboardOptions.

 

Public constructors

KeyboardOptions(     capitalization: KeyboardCapitalization?,     autoCorrect: Boolean?,     keyboardType: KeyboardType?,     imeAction: ImeAction? )

생성자는 capitalization, autoCorrect, keyboardType, imeAction 4가지로 구성되어 있습니다.

 

Public functions

KeyboardOptions	copy(     capitalization: KeyboardCapitalization?,     autoCorrect: Boolean?,     keyboardType: KeyboardType?,     imeAction: ImeAction? )
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties

Boolean	autoCorrect 자동 수정 활성화 여부를 키보드에 알립니다.
KeyboardCapitalization	capitalization 문자, 단어 또는 문장을 자동으로 대문자로 표시할지 여부를 키보드에 알립니다.
ImeAction	imeAction IME action
KeyboardType	keyboardType 이 텍스트 필드에 사용할 키보드 유형입니다.

KeyboardType에 대한 설명은 아래 글을 참고하세요.

Android KeyboardType 정리

Android KeyboardType 정리

 

Public constructors

KeyboardOptions(
    capitalization: KeyboardCapitalization? = KeyboardCapitalization.None,
    autoCorrect: Boolean? = true,
    keyboardType: KeyboardType? = KeyboardType.Text,
    imeAction: ImeAction? = ImeAction.Default
)

KeyboardOptions의 Default 값은 아래와 같습니다.

captitalization = KeyboardCapitalization.None

autoCorrect = true

keyboardType = keyboardType.text

imeAction = ImeAction.Default 

 

Parameters
capitalization: KeyboardCapitalization? = KeyboardCapitalization.None	문자, 단어 또는 문장을 자동으로 대문자로 표시할지 여부를 키보드에 알립니다. KeyboardType.Text, KeyboardType.Ascii와 같은 텍스트기반 KeyboardTypes에만 적용할 수 있습니다. KeyboardType.Number와 같은 KeyboardTypes에는 적용되지 않습니다.
autoCorrect: Boolean? = true	자동 수정 활성화 여부를 키보드에 알립니다. KeyboardType.Email, KeyboardType.Uri와 같은 텍스트 기반 KeyboardTypes에만 적용됩니다. KeyboardType.Number와 같은 KeyboardTypes에는 적용되지 않습니다. 대부분의 키보드 구현, KeyboardType.Text은 KeyboardTypes에 대해 이 값을 무시합니다.
keyboardType: KeyboardType? = KeyboardType.Text	이 텍스트 필드에 사용할 키보드 유형입니다. 이 입력 유형은 키보드에 의해 인정되고 해당 키보드를 표시하지만 보장되지는 않습니다.  예를 들어 일부 키보드는 KeyboardType.Ascii를 설정하더라도 ASCII가 아닌 문자를 보낼 수 있습니다.
imeAction: ImeAction? = ImeAction.Default	IME action. 이 IME 작업은 키보드에 의해 수행되며 키보드에 특정 아이콘을 표시할 수 있습니다.  예를 들어 ImeAction.Search가 지정된 경우 검색 아이콘이 표시될 수 있습니다. ImeOptions.singleLine이 false이면 키보드에 여기에서 요청한 작업이 아닌 반환 키가 표시될 수 있습니다.

 

아래 예제와 같이 OutlineTextField에 keyboardOptions를 줄 수 있습니다.

val value = remember {
    mutableStateOf("")
}   
OutlineTextField(value = valueState.value,
    onValueChange = { valueState.value = it },
    keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number,
    imeAction = ImeAction.Next)
)