sdk/com.m8test.script.core.api.ui.compose.widget/TextField

TextField

interface TextField<T : Modifier> : Layout<T> , Interactable

描述: 文本输入框的基础接口，与 Material 3 Composable 的参数完全同步。它包含了 TextField 和 OutlinedTextField 共有的所有配置选项。

Author

M8Test, [email protected], https://m8test.com

Inheritors

OutlinedTextField

Functions

DisposableEffect

abstract fun DisposableEffect(disposableEffectBuilder: DisposableEffect.() -> Unit)

getCompositionLocal

abstract fun <T> getCompositionLocal(name: String): ProvidableCompositionLocal<T>?

getCompositionLocalValue

abstract fun <V> getCompositionLocalValue(compositionLocal: ProvidableCompositionLocal<V>): V?

获取 compositionLocal 的值

getContext

abstract fun getContext(): ScriptContext

获取脚本上下文对象 ScriptContext.

LaunchedEffect

abstract fun LaunchedEffect(launchedEffectBuilder: LaunchedEffect.() -> Unit)

LocalColorScheme

abstract fun LocalColorScheme(): ProvidableCompositionLocal<ColorScheme>

LocalContentColor

abstract fun LocalContentColor(): ProvidableCompositionLocal<Color>

LocalShapes

abstract fun LocalShapes(): ProvidableCompositionLocal<Shapes>

LocalTextStyle

abstract fun LocalTextStyle(): ProvidableCompositionLocal<TextStyle>

LocalTypography

abstract fun LocalTypography(): ProvidableCompositionLocal<Typography>

setColors

abstract fun setColors(colors: TextFieldColors.() -> Unit)

设置用于解析此文本框在不同状态下颜色的对象。

setEnabled

abstract fun setEnabled(enabled: Boolean)

设置是否启用此文本框。

setError

abstract fun setError(isError: Boolean)

设置文本框的当前值是否处于错误状态。

setInteractionSource

abstract fun setInteractionSource(interactionSource: MutableInteractionSource)

设置用于观察和发出此组件交互的 MutableInteractionSource。

setKeyboardActions

abstract fun setKeyboardActions(keyboardActionsBuilder: KeyboardActions.() -> Unit)

设置当输入服务发出 IME 动作时要调用的回调。

setKeyboardOptions

abstract fun setKeyboardOptions(keyboardOptionsBuilder: KeyboardOptions.() -> Unit)

设置软键盘的配置选项 (例如，键盘类型和 IME 动作)。

setLabel

abstract fun setLabel(labelBuilder: UnitScopeSlot.() -> Unit)

设置显示在文本框容器内的可选标签。

setLeadingIcon

abstract fun setLeadingIcon(leadingIconBuilder: UnitScopeSlot.() -> Unit)

设置显示在文本框容器开头的前置图标。

setMaxLines

abstract fun setMaxLines(maxLines: Int)

设置文本框的最大行数 (当 singleLine 为 false 时有效)。

setMinLines

abstract fun setMinLines(minLines: Int)

设置文本框的最小行数 (当 singleLine 为 false 时有效)。

setModifier

abstract fun setModifier(modifierBuilder: T.() -> Unit)

setOnValueChange

abstract fun setOnValueChange(onValueChange: (String) -> Unit)

设置当用户输入改变文本时触发的回调。

setPlaceholder

abstract fun setPlaceholder(placeholderBuilder: UnitScopeSlot.() -> Unit)

设置当文本框聚焦且输入文本为空时显示的可选占位符。

setPrefix

abstract fun setPrefix(prefixBuilder: UnitScopeSlot.() -> Unit)

设置显示在输入文本之前的可选前缀。

setReadOnly

abstract fun setReadOnly(readOnly: Boolean)

设置此文本框是否为只读状态。

setShape

abstract fun setShape(shapeBuilder: (Shapes) -> Shape)

设置文本框容器的形状。

setSingleLine

abstract fun setSingleLine(singleLine: Boolean)

设置文本框是否为单行。

setSuffix

abstract fun setSuffix(suffixBuilder: UnitScopeSlot.() -> Unit)

设置显示在输入文本之后的可选后缀。

setSupportingText

abstract fun setSupportingText(supportingTextBuilder: UnitScopeSlot.() -> Unit)

设置显示在文本框下方的可选辅助文本。

setTextStyle

abstract fun setTextStyle(style: TextStyle.() -> Unit)

设置要应用于输入文本的样式。

setTrailingIcon

abstract fun setTrailingIcon(trailingIconBuilder: UnitScopeSlot.() -> Unit)

设置显示在文本框容器末尾的尾随图标。

setValue

abstract fun setValue(value: String)

设置在文本框中显示的输入文本。

setVisible

abstract fun setVisible(visible: Boolean)

设置显示/隐藏当前 Composable

setVisualTransformation

abstract fun setVisualTransformation(visualTransformationBuilder: (VisualTransformations) -> VisualTransformation)

设置用于转换输入值视觉表示的对象 (例如，用于密码)。

SideEffect

abstract fun SideEffect(sideEffectBuilder: SideEffect.() -> Unit)

trackAggregatedState

abstract fun trackAggregatedState(state: AggregatedState)

设置所有需要用到的聚合状态,例如 DrawerState, BottomSheetState 等

trackSingleState

abstract fun trackSingleState(state: SingleState)

添加当前 Composable 需要监听的状态，如果状态改变的话 Composable 会重组