Method TextField

Namespace

Velvet

Assembly

Velvet.Docs.dll

TextField(string?, string?, Action<string>?, string?, string?, string?, bool?, bool?, Func<VisualElement, Action>?, string?, string?, string?, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, string?, int?, bool?, bool?, bool?, TouchScreenKeyboardType?, bool?, Action<string>?, EventCallback<KeyDownEvent>?, EventCallback<KeyUpEvent>?, EventCallback<FocusInEvent>?, EventCallback<FocusOutEvent>?, Action<VisualElement>?, FiberEventBinding[]?)

Creates a TextField.

public static ElementNode TextField(string? className = null, string? value = null, Action<string>? onValueChanged = null, string? key = null, string? name = null, string? label = null, bool? isPasswordField = null, bool? enabled = null, Func<VisualElement, Action>? refCallback = null, string? whileHoverClass = null, string? whileTapClass = null, string? whileFocusClass = null, IReadOnlyDictionary<string, string>? data = null, IReadOnlyDictionary<string, string>? aria = null, string? placeholder = null, int? maxLength = null, bool? isReadOnly = null, bool? isDelayed = null, bool? multiline = null, TouchScreenKeyboardType? keyboardType = null, bool? autoCorrection = null, Action<string>? onSubmit = null, EventCallback<KeyDownEvent>? onKeyDown = null, EventCallback<KeyUpEvent>? onKeyUp = null, EventCallback<FocusInEvent>? onFocus = null, EventCallback<FocusOutEvent>? onBlur = null, Action<VisualElement>? onCreated = null, FiberEventBinding[]? events = null)

Parameters

className string

CSS-like utility class string. Multiple classes separated by spaces. Background, border, radius, padding, shadow and ring utilities style the field's box; Documentation~/styling-variants.md owns the list.

value string

Current text value (controlled).

onValueChanged Action<string>

Handler invoked when the input text changes.

key string

Key used to disambiguate siblings at the same position.

name string

Element name assigned to UnityEngine.UIElements.VisualElement.name for query/debug.

label string

Label text shown next to the field.

isPasswordField bool?

When true, masks the input as a password field.

enabled bool?

When false, disables user input.

refCallback Func<VisualElement, Action>

Callback invoked on mount with the created VisualElement; returned Action runs on unmount.

whileHoverClass string

USS class toggled while the pointer hovers the element.

whileTapClass string

USS class toggled while the pointer is pressed on the element.

whileFocusClass string

USS class toggled while the element holds keyboard/UI focus.

data IReadOnlyDictionary<string, string>

data-* attribute map matched by data-[...] variants.

aria IReadOnlyDictionary<string, string>

aria-* attribute map matched by aria-[...] variants.

placeholder string

A short hint shown in the empty field (HTML placeholder). An empty string declares an empty hint.

maxLength int?

Maximum number of characters the field accepts, -1 for no limit (HTML maxlength).

isReadOnly bool?

When true, the field cannot be edited (HTML readonly).

isDelayed bool?

When true, the value is not updated per keystroke but on Enter, on the field losing focus, and on a later render taking the flag off.

multiline bool?

When true, the field is multi-line (HTML <textarea>).

keyboardType TouchScreenKeyboardType?

Written to the field's keyboardType (HTML inputmode).

autoCorrection bool?

Written to the field's autoCorrection (HTML autocorrect).

onSubmit Action<string>

Handler invoked with the field's value when Enter commits a single-line field (a form's onSubmit from Enter in its <input>). Not invoked in a multi-line field.

onKeyDown EventCallback<KeyDownEvent>

Handler invoked for each key pressed while the field holds focus, before the field takes the key; stopping the event's propagation keeps the key out of the field.

onKeyUp EventCallback<KeyUpEvent>

Handler invoked for each key released while the field holds focus.

onFocus EventCallback<FocusInEvent>

Handler invoked when focus enters the field from outside it.

onBlur EventCallback<FocusOutEvent>

Handler invoked when focus leaves the field for somewhere outside it.

onCreated Action<VisualElement>

Callback invoked once when the TextField VisualElement is first created.

events FiberEventBinding[]

Event bindings applied to the element, bound after the field's own handlers above (Documentation~/react-migration.md owns the rule). The array is read and never written.

Returns

ElementNode

The created ElementNode representing this text field.

Remarks

placeholder, maxLength, isReadOnly, isDelayed, multiline, keyboardType and autoCorrection are undeclared when null rather than reset to a default; Documentation~/react-migration.md owns what a null and a dropped one each do.