fiori-compose-ui/com.sap.cloud.mobile.fiori.compose.text.ui/FioriNoteTextField

FioriNoteTextField

fun FioriNoteTextField(value: String, onValueChange: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, textSelectable: Boolean = true, isError: Boolean = false, content: FioriTextFieldContent = FioriTextFieldContent(), trailingIcon: FioriTextFieldIcon? = null, textStyles: FioriTextFieldTextStyles = FioriTextFieldDefaults.textStyles(), colors: FioriTextFieldColors = FioriTextFieldDefaults.colors(), styles: FioriTextFieldStyles = FioriTextFieldDefaults.styles(), keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, visualTransformation: VisualTransformation = VisualTransformation.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, onHyperlinkClick: () -> Unit? = null)

The composable FioriNoteTextField component.

The FioriTextFieldTestTags class serves as a comprehensive collection of test tags for the various components used in the FioriNoteTextField. This class is particularly beneficial for automated testing, ensuring that each UI component is properly identified and tested in accordance with best practices.

Parameters

value

the input String text to be shown in the FioriNoteTextField.

onValueChange

the callback that is triggered when the input service updates the text. An updated text comes as a parameter of the callback.

modifier

optional Modifier for this text field.

enabled

controls the enabled state of the FioriNoteTextField. When false, the text field will be neither editable nor focusable, the input of the text field will not be selectable

readOnly

controls the editable state of the FioriNoteTextField. When true, the text field can not be modified, however, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that user can not edit

textSelectable

to enable or disable the ability to select the value text in readOnly states. By default, it was true.

isError

controls the error state of the FioriNoteTextField, When true, the error was shown in the text field and error message was showing in helper text area

content

a FioriTextFieldContent object to declare all necessary information of the text field

trailingIcon

the optional trailing icon to be displayed at the end of the text field container

textStyles

FioriTextFieldTextStyles that will be used to determine the text style of FioriNoteTextField parts in different state. See FioriTextFieldDefaults.textStyles to customize

colors

FioriTextFieldColors that will be used to determine the color of the FioriNoteTextField parts in different state. See FioriTextFieldDefaults.colors to customize

styles

FioriTextFieldStyles that will be used to determine the style of the FioriNoteTextField parts in different state. E,g, the padding, height. See FioriTextFieldDefaults.styles to customize

keyboardOptions

software keyboard options that contains configuration such as KeyboardType and ImeAction.

keyboardActions

when the input service emits an IME action, the corresponding callback is called. Note that this IME action may be different from what you specified in KeyboardOptions.imeAction.

visualTransformation

The visual transformation filter for changing the visual representation of the input. By default no visual transformation is applied.

interactionSource

the MutableInteractionSource representing the stream of Interactions for this FioriNoteTextField.

onHyperlinkClick

This optional callback function is called when the hyperlink in the inline notice is clicked.

@Composable

fun FioriNoteTextField(value: TextFieldValue, onValueChange: (TextFieldValue) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, textSelectable: Boolean = true, isError: Boolean = false, content: FioriTextFieldContent = FioriTextFieldContent(), trailingIcon: FioriTextFieldIcon? = null, textStyles: FioriTextFieldTextStyles = FioriTextFieldDefaults.textStyles(), colors: FioriTextFieldColors = FioriTextFieldDefaults.colors(), styles: FioriTextFieldStyles = FioriTextFieldDefaults.styles(), keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, visualTransformation: VisualTransformation = VisualTransformation.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, onHyperlinkClick: () -> Unit? = null, assistiveInfoView: @Composable ColumnScope.() -> Unit? = null)