class ExperimentalTextInput( initialText: CharSequence = "", hint: CharSequence = "", inputBackground: Drawable? = UNSET_DRAWABLE, shadowRadius: Float = 0.0f, shadowDx: Float = 0.0f, shadowDy: Float = 0.0f, @ColorInt shadowColor: Int = Color.GRAY, textColorStateList: ColorStateList = ColorStateList.valueOf(Color.BLACK), hintColorStateList: ColorStateList = ColorStateList.valueOf(Color.LTGRAY), @ColorInt highlightColor: Int? = null, textSize: Int = TextSpec.UNSET, typeface: Typeface = Typeface.DEFAULT, textAlignment: Int = View.TEXT_ALIGNMENT_GRAVITY, @GravityInt gravity: Int = Gravity.CENTER_VERTICAL or Gravity.START, editable: Boolean = true, cursorVisible: Boolean = true, inputType: Int = EditorInfo.TYPE_CLASS_TEXT, rawInputType: Int = EditorInfo.TYPE_NULL, imeOptions: Int = EditorInfo.IME_NULL, privateImeOptions: String? = null, inputFilters: List<@JvmSuppressWildcards InputFilter?>? = null, multiline: Boolean = false, ellipsize: TextUtils.TruncateAt? = null, minLines: Int = 1, maxLines: Int = Int.MAX_VALUE, cursorDrawableRes: Int = -1, error: CharSequence? = null, errorDrawable: Drawable? = null, keyListener: KeyListener? = null, importantForAutofill: Int = 0, autofillHints: Array<String?>? = null, disableAutofill: Boolean = false, movementMethod: MovementMethod = ArrowKeyMovementMethod.getInstance(), textWatchers: List<TextWatcher>? = null, selectionActionModeCallback: ActionMode.Callback? = null, insertionActionModeCallback: ActionMode.Callback? = null, excludeFromIncrementalMount: Boolean = false, textInputController: TextInputController? = null, onTextChanged: (EditText, String) -> Unit? = null, onTextPasted: (EditText, String) -> Unit? = null, onSelectionChanged: (Int, Int) -> Unit? = null, onInputFocusChanged: (Boolean) -> Unit? = null, onKeyUp: (KeyEvent, Int) -> Boolean? = null, onKeyPreImeEvent: (KeyEvent, Int) -> Boolean? = null, onEditorAction: (TextView, KeyEvent?, Int) -> Boolean? = null, onInputConnection: (InputConnection, EditorInfo) -> InputConnection? = null, style: Style? = null) :
PrimitiveComponent Component that renders an editable text input using an android EditText. It is measured based on the input text String representation.
Performance is critical for good user experience. Follow these tips for good performance:
Avoid changing props at all costs as it forces expensive EditText reconfiguration.
Avoid updating state, use Event trigger OnTrigger to update text, request view focus or set selection. TextInput.setText(c, key, text).
Using custom inputFilters take special care to implement equals correctly or the text field must be reconfigured on every mount. (Better yet, store your InputFilter in a static or LruCache so that you're not constantly creating new instances.)
Because this component is backed by android EditText many native capabilities are applicable:
Use InputFilter to set a text length limit or modify text input.
Remove android EditText underline by removing background.
Change the input representation by passing one of the android.text.InputType constants.
It is also treated by the system as an android EditText:
When EditText receives focus, a system keyboard is shown.
When the user opens the screen and android EditText is the first element in the View hierarchy, it gains focus.
Example of multiline editable text with custom text color, text length limit, removed underline drawable, and sentence capitalisation:
private val lenFilter: InputFilter = InputFilter.LengthFilter(maxLength);
ExperimentalTextInput(
initialText = text,
textColorStateList = ColorStateList.valueOf(color),
multiline = true,
inputFilter = lenFilter,
backgroundColor = Color.TRANSPARENT,
inputType =InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_FLAG_CAP_SENTENCES,
)
See also