Mobile UI/org.hisp.dhis.mobile.ui.designsystem.component/BasicTextField

BasicTextField

@Composable
fun BasicTextField(helper: String? = null, enabled: Boolean = true, isSingleLine: Boolean = true, helperStyle: HelperStyle = HelperStyle.NONE, inputTextValue: TextFieldValue? = null, onInputChanged: (TextFieldValue) -> Unit, modifier: Modifier = Modifier, state: InputShellState = InputShellState.FOCUSED, keyboardOptions: KeyboardOptions = KeyboardOptions(imeAction = ImeAction.Done), visualTransformation: VisualTransformation? = null, onNextClicked: () -> Unit? = null, onSearchClicked: () -> Unit? = null)

DHIS2 Basic Input. Wraps Material 3· BasicTextField.

Parameters

helper

: Manages the helper text to be shown.

enabled

: Controls the enabled state of the component. When false, this component will not be clickable and will appear disabled to accessibility services.

isSingleLine

: manages the number of lines to be allowed in the input field.

helperStyle

: manages the helper text style, NONE by default.

inputTextValue

: manages the value of the input field text.

onInputChanged

: gives access to the onTextChangedEvent.

modifier

: to pass a modifier if necessary.

state

: manages the color of cursor depending on the state of parent component.

keyboardOptions

: manages the ImeAction to be shown on the keyboard.

visualTransformation

: manages custom visual transformation. When null it will use the visual transformation created based on helper style, when a visual transformation is passed it will ignore the helper style.

onNextClicked

: gives access to the ImeAction event.

onSearchClicked

: gives access to the ImeAction Search event.