Skip to content

@minecraft/server-ui


@minecraft/server-ui / TextFieldOptions

Interface: TextFieldOptions

Defined in: @minecraft/server-ui/index.d.ts:1783

Options for configuring a text field component.

Properties

description?

optional description?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Defined in: @minecraft/server-ui/index.d.ts:1790

Remarks

Descriptive text shown around the text field label to provide additional context.


disabled?

optional disabled?: boolean | ObservableBoolean

Defined in: @minecraft/server-ui/index.d.ts:1797

Remarks

When true or bound to a true ObservableBoolean, the text field is shown but cannot be edited.


visible?

optional visible?: boolean | ObservableBoolean

Defined in: @minecraft/server-ui/index.d.ts:1804

Remarks

When false or bound to a false ObservableBoolean, the text field is hidden.