TextBox¶

Supported Class GUI

A 2D user interface element that displays player-editable text.

34 Nova members · 7 modern Roblox members not implemented yet

Description¶

A TextBox allows the player to provide text input. It behaves similarly to a TextButton, except that a single TextBox can be put in focus by clicking, tapping, or gamepad selection. While in focus, the player can use a keyboard to change the Text property.

If there is no text, the PlaceholderText will be visible. This is useful prompting players of the kind or format of data they should input.
By default, the ClearTextOnFocus property is enabled and ensures there is no existing text when a TextBox is focused. This may not be desirable for text that should be editable by the player.
The MultiLine property allows players to enter multiple lines of text with newline characters (\n).

Focus State¶

It is possible to detect and change the focus state of a TextBox:

You can use CaptureFocus when a dialogue appears so that the player doesn't have to click on a TextBox when it becomes available; you can use ContextActionService.BindAction() to bind a certain key to focus a TextBox using this function. When a TextBox comes into focus, the Focused event fires.
You can detect if a certain TextBox is in focus by using IsFocused. Alternatively, UserInputService.GetFocusedTextBox() can be used to check if any TextBox is in focus.
When the player is done inputting text, the FocusLost event fires, indicating if the player pressed Enter to submit text along with the InputObject that caused the loss of focus. When using on-screen keyboards on mobile and console, ReturnPressedFromOnScreenKeyboard may also fire.
If some more important matter comes up during gameplay, you can ReleaseFocus of the TextBox so that a player's keyboard input returns to your game.

Text Editing¶

A TextBox supports text selection through its CursorPosition and SelectionStart properties. Using GetPropertyChangedSignal, you can detect when a selection changes. Additionally, it is possible for players to copy and paste text within a TextBox, enabling basic clipboard support. When the cursor moves outside the visible area while typing or navigating, the TextBox automatically scrolls its viewport to keep the cursor in view.

Text Filtering Notice Games that facilitate player-to-player communication using text, such as custom chat or nametags, must properly filter such text using TextService.FilterStringAsync() or Chat.FilterStringAsync(). If this is not properly done, your game may receive moderation action.

Inheritance¶

Object → Instance → GuiBase → GuiBase2d → GuiObject → TextBox

Nova inheritance: Instance → GuiBase → GuiBase2d → GuiObject → TextBox

Properties¶

ClearTextOnFocus Supported Property Determines whether clicking on the TextBox will clear its TextBox.Text property.

ClearTextOnFocus: bool

Determines whether clicking on the TextBox will clear its TextBox.Text property

RichText	Text	ContentText
`false`	<b>Hello,<br/> world!</b>	<b>Hello,<br/> world!</b>
`true`	<b>Hello,<br/> world!</b>	Hello, world!

Member	Signature	Status	Notes	Flags
`OpenTypeFeatures`	`OpenTypeFeatures: string`	Not yet	Applies OpenType typographic features to the text rendered by the TextBox.	—
`OpenTypeFeaturesError`	`OpenTypeFeaturesError: string`	Not yet	Read-only property that describes why the TextBox.OpenTypeFeatures string could not be applied.	ReadOnly, NotReplicated
`ShowNativeInput`	`ShowNativeInput: bool`	Not yet	If set to `true`, input native to the platform is used instead of Roblox's built-in keyboard.	—
`TextDirection`	`TextDirection: TextDirection`	Not yet	Direction in which the text is rendered.	—

Member	Signature	Status	Notes	Flags
`ResetKeyboardMode`	`TextBox:ResetKeyboardMode(): null`	Not yet	—	RobloxScriptSecurity
`SetTextFromInput`	`TextBox:SetTextFromInput(text: string): null`	Not yet	—	RobloxScriptSecurity

TextBox¶

Description¶

Focus State¶

Text Editing¶

Inheritance¶

Properties¶

Methods¶

Events¶

Inherited members¶

Properties¶

Methods¶

Events¶