TextBox

Show Deprecated
A TextBox being clicked on and typed into in Roblox Studio

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).

The ContextActionService honors TextBox keybinds and will automatically prevent key press events from being passed to actions bound with ContextActionService:BindAction(). UserInputService.InputBegan and related events will still fire while a TextBox is in focus.

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 user 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 with text being selected, copied and pasted

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.

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.

Code Samples

TextBox Secret Word

1-- Place this code in a LocalScript inside a TextBox
2local textBox = script.Parent
3
4local secretWord = "roblox"
5local colorNormal = Color3.new(1, 1, 1) -- white
6local colorWrong = Color3.new(1, 0, 0) -- red
7local colorCorrect = Color3.new(0, 1, 0) -- green
8
9-- Initialize the state of the textBox
10textBox.ClearTextOnFocus = true
11textBox.Text = ""
12textBox.Font = Enum.Font.Code
13textBox.PlaceholderText = "What is the secret word?"
14textBox.BackgroundColor3 = colorNormal
15
16local function onFocused()
17 textBox.BackgroundColor3 = colorNormal
18end
19
20local function onFocusLost(enterPressed, _inputObject)
21 if enterPressed then
22 local guess = textBox.Text
23 if guess == secretWord then
24 textBox.Text = "ACCESS GRANTED"
25 textBox.BackgroundColor3 = colorCorrect
26 else
27 textBox.Text = "ACCESS DENIED"
28 textBox.BackgroundColor3 = colorWrong
29 end
30 else
31 -- The player stopped editing without pressing Enter
32 textBox.Text = ""
33 textBox.BackgroundColor3 = colorNormal
34 end
35end
36
37textBox.FocusLost:Connect(onFocusLost)
38textBox.Focused:Connect(onFocused)

Summary

Properties

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

READ ONLY
NOT REPLICATED

Determines the offset of the text cursor in bytes, or -1 if there is no cursor.

Determines the font used to render text.

Determines the font used to render text.

Scales the spacing between lines of text in the TextBox.

The maximum number of graphemes the TextBox can show.

When set to true, text inside a TextBox is able to move onto multiple lines. This also enables players to use the enter key to move onto a new line.

Sets the text color that gets used when no text has been entered into the TextBox yet.

Sets the text that gets displayed when no text has been entered into the TextBox yet.

Determines whether the TextBox renders the TextBox.Text string using rich text formatting.

Determines the starting position of a text selection, or -1 if no text is selected.

If set to true, input native to the platform is used instead of Roblox's built-in keyboard.

Determines the string rendered by the UI element.

The size of a UI element's text in offsets.

READ ONLY
NOT REPLICATED

Determines the color of rendered text.

Determines whether the user can change the Text.

Whether the text fits within the constraints of the TextBox.

READ ONLY
NOT REPLICATED

Changes whether text is resized to fit the GUI object that renders it.

Determine the line height of text in offsets.

Determines the color of the text stroke (outline).

Determines the transparency of the text stroke (outline).

Determines the transparency of rendered text.

Controls the truncation of the text displayed in this TextBox.

Determines if text wraps to multiple lines within the GUI element space, truncating excess text.

Determines the horizontal alignment of rendered text.

Determines the vertical alignment of rendered text.

Events

FocusLost(enterPressed: boolean, inputThatCausedFocusLoss: InputObject): RBXScriptSignal  

The FocusLost event fires when the client lets their focus off the TextBox.


Fires when the TextBox gains focus.

Methods


Forces the client to focus on the TextBox.


Returns true if the textbox is focused, or false if it is not.

ReleaseFocus(submitted: boolean): nil  

Forces the client to unfocus the TextBox.

Properties

ClearTextOnFocus

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

ContentText

Read Only
Not Replicated

CursorPosition

CursorPosition determines the offset of the text cursor in bytes, or -1 if the TextBox is not currently being edited. A value of 1 represents the beginning, the position before the first byte in the Text property. When used in conjunction with the SelectionStart property, it is possible to both get and set selected text within a TextBox.

A visual explanation of how CursorPosition works

It should be noted that the units of this property is bytes and that many unicode characters such as emoji are longer than 1 byte. For instance, if a player types into the TextBox "Hello👋" – "Hello" immediately followed by the waving hand sign – the cursor position would be 10, not 7, since the emoji uses 4 bytes.

Font

The Font property selects one of several pre-defined fonts with which the UI element will render its text. Some fonts have bold, italic and/or light variants (as there is no font-weight or font-style properties).

With the exception of the "Legacy" font, each font will render text with the line height equal to the TextBox.TextSize property. The "Code" font is the only monospace font. It has the unique property that each character has the exact same width and height ratio of 1:2. The width of each character is approximately half the TextBox.TextSize property.

This property is kept in sync with the TextBox.FontFace property. When setting Font, the FontFace will be set to Font.fromEnum().

FontFace

The FontFace property is similar to the Font property, but allows setting fonts that don't exist in the Font enum.

This property is kept in sync with the TextBox.Font property. When setting FontFace, the Font is set to the corresponding enum value, or to Font.Unknown if there are no matches.

LineHeight

Controls the height of lines, as a multiple of the font's em square size, by scaling the spacing between lines of text in the TextBox. Valid values range from 1.0 to 3.0, defaulting to 1.0.

MaxVisibleGraphemes

This property controls the maximum number of graphemes (or units of text) that are shown on the TextBox, regardless of whether it's showing the TextBox.PlaceholderText or TextBox.Text.

Changing the property does not change the position or size of the visible graphemes - the layout will be calculated as if all graphemes are visible.

Setting the property to -1 disables the limit and shows the entirety of the TextBox.Text.

MultiLine

When set to true, text inside a TextBox is able to move onto multiple lines. This also enables players to use the enter key to move onto a new line.

PlaceholderColor3

Sets the text color that gets used when no text has been entered into the TextBox yet.

PlaceholderText

Sets the text that gets displayed when no text has been entered into the TextBox yet.

RichText

This property determines whether the TextBox renders the TextBox.Text string using rich text formatting. Rich text uses simple markup tags to style sections of the string in bold, italics, specific colors, and more.

To use rich text, simply include formatting tags in the TextBox.Text string.

Note that when the TextBox has this property enabled and the box gains focus, the user will be able to edit and interact with the complete XML string, including all of the formatting tags. When focus is lost, the text will automatically parse and render the tags as rich text.

SelectionStart

Determines the starting position of a text selection, or -1 if the TextBox has no range of selected text. If the value is -1 or equivalent to CursorPosition, there is no range of text selected. This property uses the same positioning logic as CursorPosition. SelectionStart will be greater than CursorPosition if the cursor is at the beginning of a selection, and less than CursorPosition if the cursor is at the end.

ShowNativeInput

If set to true, input native to the platform is used instead of Roblox's built-in keyboard.

Text

The Text property determines the content rendered by the UI element. The visual properties of the string rendered to the screen is determined by TextBox.TextColor3, TextBox.TextTransparency, TextBox.TextSize, TextBox.Font, TextBox.TextScaled, TextBox.TextWrapped, TextBox.TextXAlignment and TextBox.TextYAlignment.

It is possible to render emoji (for example, 😃) and other symbols. These special symbols aren't affected by the TextBox.TextColor3 property. These can be pasted into Script and LocalScript objects, as well as the field within the Properties window.

This property may contain newline characters, however, it is not possible to type newline characters within the Properties window. Similarly, this property may contain a tab character, but it will render as a space instead.

TextBounds

Read Only
Not Replicated

The read-only property TextBounds reflects the absolute size of rendered text in offsets. In other words, if you were to try to fit text into a rectangle, this property would reflect the minimum dimensions of the rectangle you would need in order to fit the text.

Using TextService:GetTextSize(), you can predict what TextBounds will be on a TextLabel given a string, TextBox.Font, TextBox.TextSize and frame size.

TextColor3

This property determines the color of all the text rendered by a GUI element. This property along with TextBox.Font, TextBox.TextSize and TextBox.TextTransparency will determine the visual properties of text. Text is rendered after the text stroke (TextBox.TextStrokeColor3).

It's important that text is easily read by players! Be sure to choose colors with little-to-no saturation, like white, grey, or black. Make sure the color of your text is contrasted by the TextBox.BackgroundColor3 of the UI element. If the element has a transparent background, try applying a black TextBox.TextStrokeColor3 to help contrast the text with the 3D world behind it.

TextEditable

TextEditable determines whether the user can change the Text through input. It is recommended to disable ClearTextOnFocus when this property is disabled, otherwise the Text could be cleared on-focus. This property is useful to make read-only TextBoxes from which content can be copied in-game.

TextFits

Read Only
Not Replicated

Whether the text fits within the constraints of the TextBox.

TextScaled

Rather than using TextScaled, we recommend you consider using AutomaticSize, a new method to dynamically size UI that will give you the best visual result possible.

The TextScaled property determines whether text is scaled so that it fills the entire UI element's space. When this is enabled, TextBox.TextSize is ignored and TextBox.TextWrapped is automatically enabled. This property is useful for text-rendering UI elements within BillboardGuis.

When this property is used for screen-space UI, it may be desirable to use a UITextSizeConstraint to restrict the range of possible text sizes.

TextScaled and AutomaticSize

It's recommended that developers avoid usage of TextScaled and adjust UI to take advantage of the AutomaticSize property instead. Here are the core differences between the two properties:

  • TextScaled scales the content (text) to accommodate the UI. Without careful consideration, some text may become unreadable if scaled too small.
  • AutomaticSize resizes the UI to accommodate content.

With AutomaticSize, you're able to adjust your UI to accommodate the content (text) while maintaining a consistent font size. For more information on how to use automatic sizing, see the UI Automatic Size article.

We suggest that you don't apply both TextScaled and AutomaticSize on the same UI object. If you apply both properties:

  • AutomaticSize determines the maximum amount of available space that a GuiObject can use (in this case, text)
  • TextScaled uses the available space determined by AutomaticSize, to scale the font size to fit the available space, which will expand up to the maximum font size (100), if there are no size constraints
  • The end result will be: text goes to 100 font size and the UI object will expand to fit that text

Using both AutomaticSize and TextScaled at the same time can result in significant scaling differences than when AutomaticSize is off. Here is an example of an automatically sized TextLabel (with no minimum size) that has TextScaled enabled:

TextScaled Demo

Note how automatic size changes the TextLabel's size relative to the parent frame's size. Subsequently, as the TextLabel is resized, the TextScaled property scales the text to the maximum amount of space available by the automatically sized TextLabel.

TextSize

The TextSize property determines the height in offsets of one line of rendered text. The unit is in offsets, not points (which is used in most document editing programs). The "Legacy" font does not hold this property.

TextStrokeColor3

The TextStrokeColor3 property sets the color of the stroke, or outline, of rendered text. This property and TextBox.TextStrokeTransparency determine the visual properties of the text stroke.

Text stroke is rendered before normal text and is simply 4 renderings of the same text in +/- 1 pixel offsets in each direction. Text stroke rendering works independently and identically to TextBox.TextColor3 and TextBox.TextTransparency.

TextStrokeTransparency

The TextStrokeTransparency property sets the transparency of the stroke, or outline, of rendered text. This property and TextBox.TextStrokeColor3 determine the visual properties of the text stroke.

Text stroke is rendered before normal text and is simply 4 renderings of the same text in +/- 1 pixel offsets in each direction. Text stroke rendering works independently and identically to TextBox.TextColor3 and TextBox.TextTransparency. Since text stroke is simply multiple renderings of the same transparency, this property is essentially multiplicative on itself four times over (e.g. a TextStrokeTransparency of 0.5 appears about the same as TextTransparency of 0.0625, or 0.5^4). Therefore, it's recommended to set TextStrokeTransparency to a value in the range of 0.75 to 1 for more a more subtle effect.

TextTransparency

The TextColor3 property determines the transparency of all the text rendered by a UI element. This property along with TextBox.Font, TextBox.TextSize and TextBox.TextColor3 will determine the visual properties of text. Text is rendered after the text stroke (TextBox.TextStrokeTransparency).

Fading text in using a numeric for-loop is a fantastic way to draw a player's attention to text appearing on screen.


1-- Count backwards from 1 to 0, decrementing by 0.1
2for i = 1, 0, -.1 do
3 textLabel.TextTransparency = i
4 wait(.1)
5end
6

TextTruncate

Controls the truncation of the text displayed in this TextBox.

TextWrapped

When enabled, this property will render text on multiple lines within a GUI element's space so that TextBox.TextBounds will never exceed the GuiBase2d.AbsoluteSize of the GUI element.

This is achieved by breaking long lines of text into multiple lines. Line breaks will prefer whitespace; should a long unbroken word exceed the width of the element, that word will be broken into multiple lines.

If further line breaks would cause the vertical height of the text (the Y component of TextBox.TextBounds) to exceed the vertical height of the element (the Y component of GuiBase2d.AbsoluteSize), then that line will not be rendered at all.

TextXAlignment

TextXAlignment determines the horizontal alignment (X-axis) of text rendered within a UI element's space. It functions similarly to the CSS text-align property, with left, right and center values (there is no justify option). For Left and Right, text is rendered such that the left/right text bounds just touch the edge of the UI element rectangle. For Center, each line of text is centered on the very center of the UI element rectangle.

This property is used in conjunction with TextBox.TextYAlignment to fully determine text alignment on both axes. This property won't affect the read-only properties TextBox.TextBounds and TextBox.TextFits.

TextYAlignment

TextYAlignment determines the vertical alignment (Y-axis) of text rendered within a UI element's space. For Top and Bottom, text is rendered such that the top/bottom text bounds just touch the edge of the UI element rectangle. For Center, text is rendered such that there is an equal space from the top bounds of the text to the top of the element and the bottom bounds of the text to the bottom of the element.

This property is used in conjunction with TextBox.TextXAlignment to fully determine text alignment on both axes. This property won't affect the read-only properties TextBox.TextBounds and TextBox.TextFits.

Events

FocusLost

The FocusLost event fires when the client lets their focus off the TextBox - typically when a client clicks/taps on a TextBox to begin text entry. This also fires if a TextBox forces focus on the user.

It can be used alongside TextBox.Focus to track when a TextBox gains and loses focus.

See also the UserInputService.TextBoxFocused and UserInputService.TextBoxFocusReleased for similar functions that rely on the UserInputService service.

This event will only fire when used in a LocalScript.

Parameters

enterPressed: boolean

A boolean indicating whether the client pressed Enter to lose focus (true) or not (false).

inputThatCausedFocusLoss: InputObject

An InputObject instance indicating the type of input that caused the TextBox to lose focus.


Code Samples

FocusLost

1local textBox = script.Parent
2
3local function onFocusLost(enterPressed, inputThatCausedFocusLost)
4 if enterPressed then
5 print("Player pressed Enter")
6 else
7 print("Player pressed", inputThatCausedFocusLost.KeyCode)
8 end
9end
10
11textBox.FocusLost:Connect(onFocusLost)
TextBox.FocusLost1

1local function focusLost(enterPressed)
2 if enterPressed then
3 print("Focus was lost because enter was pressed!")
4 end
5end
6
7script.Parent.FocusLost:Connect(focusLost)

Focused

The Focused event fires when the TextBox gains focus - typically when a client clicks/taps on a TextBox to begin text entry. This also fires if a TextBox forces focus on the user.

It can be used alongside TextBox.FocusLost to track when a TextBox gains and loses focus.

See also the UserInputService.TextBoxFocused and UserInputService.TextBoxFocusReleased for similar functions that rely on the UserInputService service.

This event will only fire when used in a LocalScript.


Code Samples

Focus

1local textBox = script.Parent
2
3local function onFocused()
4 print("Focused")
5end
6
7textBox.Focused:Connect(onFocused)

ReturnPressedFromOnScreenKeyboard


Methods

CaptureFocus

Forces the client to focus on the TextBox.


Returns

Code Samples

TextBox:CaptureFocus

1local ContextActionService = game:GetService("ContextActionService")
2
3local ACTION_NAME = "FocusTheTextBox"
4
5local textBox = script.Parent
6
7local function handleAction(actionName, inputState, _inputObject)
8 if actionName == ACTION_NAME and inputState == Enum.UserInputState.Begin then
9 textBox:CaptureFocus()
10 end
11end
12
13ContextActionService:BindAction(ACTION_NAME, handleAction, false, Enum.KeyCode.Q)

IsFocused

Returns true if the textbox is focused, or false if it is not.


Returns

ReleaseFocus

Forces the client to unfocus the TextBox. The submitted parameter allows you to over-ride the enterPressed parameter in the TextBox.FocusLost event.

This item should be used with a LocalScript in order to work as expected in online mode.

The code shown below will force the client to unfocus the 'TextBox' 5 seconds after it's selected:


1local TextBox = script.Parent
2TextBox.Focused:Connect(function()
3 wait(5)
4 TextBox:ReleaseFocus()
5end)
6

Please be aware that the above example assumes that it's in a LocalScript, as a child of a TextBox.

Parameters

submitted: boolean
Default Value: "false"

Returns

Code Samples

TextBox:ReleaseFocus

1local textBox = script.Parent
2
3local function onFocused()
4 task.wait(5)
5 textBox:ReleaseFocus()
6end
7
8textBox.Focused:Connect(onFocused)

ResetKeyboardMode

Roblox Script Security

Returns

SetTextFromInput

Roblox Script Security

Parameters

text: string

Returns