api/dev.s7a.strata.component/TextField

TextField

@JvmName(name = "TextFieldStatebdacf61484d9_1")
fun UiScope.TextField(state: TextFieldState, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldState06eec201bfdd_1")
fun UiScope.TextField(state: TextFieldState, size: IntSize, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldStateac020717728e_1")
fun UiScope.TextField(state: TextFieldState, font: ResourceId, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldState0f2e4a0352af_1")
fun UiScope.TextField(state: TextFieldState, size: IntSize, font: ResourceId, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldState8ebce6a07628_1")
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldState68d5823f42d7_1")
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, size: IntSize, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldState715dafc3f527_1")
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, font: ResourceId, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
@JvmName(name = "TextFieldStatefd7b3be167e7_1")
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, size: IntSize, font: ResourceId, enabled: StateSource<Boolean>, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Source-backed TextField observing enabled at the next frame cutoff. Sources remain caller-owned; compatible nodes retain editing, focus, and scrolling state. Literal arguments keep their existing contracts. Equal source values do not re-evaluate this component. The complete modifier chain stays on the actual component; the wrapper delegates parent data and owns the sibling key. Keep sources and dedicated editing states outside observed callbacks. Evaluation and input failures follow ordinary runtime cleanup.

fun UiScope.TextField(state: TextFieldState, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Emits one 200 by 20 single-line text field.

Editing preserves Unicode scalars while TextFieldState.maxLength counts UTF-16 code units. Delivered preedit text remains inline presentation state until committed input arrives. The component does not install a platform candidate window or add selection and clipboard commands.

Receiver

active owner-thread screen scope.

Parameters

state

owner-thread text value observed by the retained field.

enabled

whether focus and editing are accepted.

textStyle

profile-backed glyph style.

modifier

active behavior applied to the field.

key

optional stable sibling identity.

Throws

when the scope or state thread is invalid or no runtime evaluation is active.

fun UiScope.TextField(state: TextFieldState, size: IntSize, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Emits one explicitly sized single-line text field.

Receiver

active owner-thread screen scope.

Parameters

state

owner-thread text value observed by the retained field.

size

exact logical field extent.

enabled

whether focus and editing are accepted.

textStyle

profile-backed glyph style.

modifier

active behavior applied to the field.

key

optional stable sibling identity.

Throws

when size cannot contain the field or later constraints exclude it.

when the scope or state thread is invalid or no runtime evaluation is active.

fun UiScope.TextField(state: TextFieldState, font: ResourceId, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Emits one 200 by 20 single-line text field using an explicitly selected resource-pack font.

Receiver

active owner-thread screen scope.

Parameters

state

caller-owned text value observed by the retained field.

font

structural identifier of the font definition.

enabled

whether focus and editing are accepted.

textStyle

profile-backed color and shadow policy.

modifier

active behavior applied to the field.

key

optional stable sibling identity.

Throws

when the scope or state thread is invalid or no runtime evaluation is active.

fun UiScope.TextField(state: TextFieldState, size: IntSize, font: ResourceId, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Emits one explicitly sized single-line text field using a selected resource-pack font.

The selected font supplies both drawing and cursor metrics from the runtime's pinned resource state. Movement and deletion operate on Unicode scalars, not grapheme clusters, and TextFieldState.maxLength remains a UTF-16 bound.

Receiver

active owner-thread screen scope.

Parameters

state

caller-owned text value observed by the retained field.

size

exact logical field extent.

font

structural identifier of the font definition.

enabled

whether focus and editing are accepted.

textStyle

profile-backed color and shadow policy.

modifier

active behavior applied to the field.

key

optional stable sibling identity.

Throws

when size cannot contain the field or later constraints exclude it.

when the scope or state thread is invalid or no runtime evaluation is active.

fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, size: IntSize, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, font: ResourceId, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)
fun UiScope.TextField(state: TextFieldState, appearance: TextInputAppearance, size: IntSize, font: ResourceId, enabled: Boolean = true, textStyle: TextStyle = TextStyle.TextField, modifier: Modifier = Modifier.Empty, key: ElementKey<*>? = null)(source)

Emits a retained TextField with a per-editor appearance. Geometry, state ownership, font, wrapping, and input behavior follow the corresponding ordinary overload. Appearance images are resolved at evaluation; invalid nine-slice borders fail before a frame is presented. Keep state and images outside reevaluated content. Appearance-only changes preserve focus, composition, and scroll. Use TextStyle.ContainerLabel for dark text on light frames; the appearance controls caret and composition colors.

Throws

when the installed runtime lacks custom appearance support.

Generated by Dokka
© 2026 Copyright