TextBox
An editable text field in a GUI.
Behavior
TextBox accepts text input and exposes the shared GUI text-layout properties.
Use its focus events to react to editing state.
Summary
The resolved top-left position of this interface element in pixels.
The resolved rotation of this interface element in degrees, including ancestor rotation.
The resolved width and height of this interface element in pixels.
Whether this interface accepts and consumes input.
The normalized point within the element used as the origin for Position.
The dimensions that resize to fit the element's content.
The color used to fill the element's background.
The background transparency, from 0 for opaque to 1 for invisible.
The color of the element's border.
Whether the border is drawn outside, across, or inside the element's bounds.
The border thickness in pixels.
Whether the text is cleared when the TextBox gains focus.
Whether descendant rendering is clipped to this element's bounds.
The text content after rich-text markup has been removed.
The corner radius used for the element's rounded background.
The individual corner radii used for the element's rounded background.
The text insertion position.
Whether pointer dragging can move the element.
The typeface used to render the text.
Whether the text uses the monospaced font option.
The style applied to the text.
The weight applied to the text.
The share of remaining main-axis space assigned to this child in flow layout.
The element's current idle, hover, pressed, or non-interactable state.
Which input events this element consumes before they reach elements behind it.
Whether the element accepts interaction.
Whether children use flow layout or their explicit positions.
The numeric order of this element when a parent layout sorts by layout order.
The additional spacing between text glyphs.
The line-height multiplier used for multi-line text.
The maximum number of visible graphemes.
Whether the TextBox accepts multiple lines of text.
The interface element selected when navigating down from this element.
The interface element selected when navigating left from this element.
The interface element selected when navigating right from this element.
The interface element selected when navigating up from this element.
The opacity multiplier applied to this element and its descendants.
The text displayed while the TextBox is empty.
The color used for the TextBox placeholder.
The element position relative to its parent.
Fires when a text-input key is pressed.
Fires when a text-input key is released.
Whether markup in the text is parsed and rendered as rich text.
The interface rotation in degrees.
Whether interface navigation can select this element.
The currently selected text.
The interface element used to draw the selection indicator.
The numeric order used for interface selection traversal.
The start of the text selection.
The element size relative to its parent.
The parent axes used to resolve relative interface size.
The text displayed by the element.
The resolved pixel bounds of the rendered text.
The color used to render text.
Whether the user can edit the TextBox text.
Whether the rendered text fits within the text box's bounds.
Whether the engine scales the text to fit the text box's bounds.
The base text size in pixels.
The color used for the outline around text glyphs.
The transparency of the outline around text glyphs.
The text transparency, from 0 for opaque to 1 for invisible.
The truncation mode used when text does not fit.
Whether text wraps onto additional lines within the element's width.
The horizontal alignment of text within the element.
The vertical alignment of text within the element.
Whether this interface element is rendered.
The element's draw-order index.
Gives keyboard focus to this interface element.
Returns this instance if it is an ExecutionGroup.
Removes keyboard focus from this interface element.
Fires when pointer dragging of the element begins.
Fires when pointer dragging of the element ends.
Fires when the TextBox loses keyboard focus.
Fires when the TextBox gains keyboard focus.
Fires when input begins over or is dispatched to this interface element.
Fires when input dispatched to this element changes.
Fires when input dispatched to this element ends.
Fires when the mouse wheel scrolls backward over this element.
Fires when the mouse wheel scrolls forward over this element.
Fires when a pointer moves onto the text box.
Fires when a pointer moves off the text box.
Fires when the pointer moves across the text box.
Fires when interface navigation selects this element.
Fires when this element loses interface selection.
Properties
AbsolutePosition
TextBox.AbsolutePosition: Vector2 = Vector2.new(0, 0)The resolved top-left position of this interface element in pixels.
AbsoluteRotation
TextBox.AbsoluteRotation: number = 0The resolved rotation of this interface element in degrees, including ancestor rotation.
AbsoluteSize
TextBox.AbsoluteSize: Vector2 = Vector2.new(0, 0)The resolved width and height of this interface element in pixels.
Active
TextBox.Active: boolean = trueWhether this interface accepts and consumes input.
AnchorPoint
TextBox.AnchorPoint: Vector2 = Vector2.new(0, 0)The normalized point within the element used as the origin for Position. (0, 0) is the top-left corner; (0.5, 0.5) is the center.
AutomaticSize
TextBox.AutomaticSize: Enum.AutomaticSize = Enum.AutomaticSize.NoneThe dimensions that resize to fit the element's content.
BackgroundColor3
TextBox.BackgroundColor3: Color3 = Color3.new(0.6392157, 0.63529414, 0.64705884)The color used to fill the element's background.
BackgroundTransparency
TextBox.BackgroundTransparency: number = 0The background transparency, from 0 for opaque to 1 for invisible.
BorderColor3
TextBox.BorderColor3: Color3 = Color3.new(0.105882354, 0.16470589, 0.20784314)The color of the element's border.
BorderMode
TextBox.BorderMode: Enum.BorderMode = Enum.BorderMode.OutlineWhether the border is drawn outside, across, or inside the element's bounds.
BorderSizePixel
TextBox.BorderSizePixel: number = 1The border thickness in pixels.
ClearTextOnFocus
TextBox.ClearTextOnFocus: boolean = trueWhether the text is cleared when the TextBox gains focus.
ClipsDescendants
TextBox.ClipsDescendants: boolean = falseWhether descendant rendering is clipped to this element's bounds.
ContentText
TextBox.ContentText: stringThe text content after rich-text markup has been removed. Read-only.
CornerRadius
TextBox.CornerRadius: number = 0The corner radius used for the element's rounded background.
Corners
TextBox.Corners: { number } = {}The individual corner radii used for the element's rounded background.
CursorPosition
TextBox.CursorPosition: numberThe text insertion position. A value of -1 indicates no active cursor.
Draggable
TextBox.Draggable: boolean = falseWhether pointer dragging can move the element.
FontFace
TextBox.FontFace: Font = ""The typeface used to render the text.
FontMono
TextBox.FontMono: booleanWhether the text uses the monospaced font option.
FontStyle
TextBox.FontStyle: Enum.FontStyle = Enum.FontStyle.NormalThe style applied to the text.
FontWeight
TextBox.FontWeight: Enum.FontWeight = Enum.FontWeight.RegularThe weight applied to the text.
Grow
TextBox.Grow: number = 0The share of remaining main-axis space assigned to this child in flow layout.
GuiState
TextBox.GuiState: Enum.GuiState = Enum.GuiState.IdleThe element's current idle, hover, pressed, or non-interactable state.
InputSink
TextBox.InputSink: Enum.InputSink = Enum.InputSink.NoneWhich input events this element consumes before they reach elements behind it.
Interactable
TextBox.Interactable: boolean = trueWhether the element accepts interaction.
Layout
TextBox.Layout: Enum.Layout = Enum.Layout.FlowWhether children use flow layout or their explicit positions.
LayoutOrder
TextBox.LayoutOrder: number = 0The numeric order of this element when a parent layout sorts by layout order.
LetterSpacing
TextBox.LetterSpacing: numberThe additional spacing between text glyphs.
LineHeight
TextBox.LineHeight: numberThe line-height multiplier used for multi-line text.
MaxVisibleGraphemes
TextBox.MaxVisibleGraphemes: numberThe maximum number of visible graphemes. A negative value shows all graphemes.
MultiLine
TextBox.MultiLine: boolean = falseWhether the TextBox accepts multiple lines of text.
NextSelectionDown
TextBox.NextSelectionDown: GuiObject? = nilThe interface element selected when navigating down from this element.
NextSelectionLeft
TextBox.NextSelectionLeft: GuiObject? = nilThe interface element selected when navigating left from this element.
NextSelectionRight
TextBox.NextSelectionRight: GuiObject? = nilThe interface element selected when navigating right from this element.
NextSelectionUp
TextBox.NextSelectionUp: GuiObject? = nilThe interface element selected when navigating up from this element.
Opacity
TextBox.Opacity: number = 1The opacity multiplier applied to this element and its descendants.
Placeholder
TextBox.Placeholder: stringThe text displayed while the TextBox is empty.
PlaceholderColor
TextBox.PlaceholderColor: Color3The color used for the TextBox placeholder.
Position
The element position relative to its parent. Scale components use the parent size; offsets are in pixels.
Pressed
TextBox.Pressed: AstScriptSignal<>Fires when a text-input key is pressed.
Released
TextBox.Released: AstScriptSignal<>Fires when a text-input key is released.
RichText
TextBox.RichText: booleanWhether markup in the text is parsed and rendered as rich text.
Rotation
TextBox.Rotation: number = 0The interface rotation in degrees.
Selectable
TextBox.Selectable: boolean = falseWhether interface navigation can select this element.
SelectedText
TextBox.SelectedText: stringThe currently selected text.
SelectionImageObject
TextBox.SelectionImageObject: GuiObject? = nilThe interface element used to draw the selection indicator.
SelectionOrder
TextBox.SelectionOrder: number = 0The numeric order used for interface selection traversal.
SelectionStart
TextBox.SelectionStart: numberThe start of the text selection. A value of -1 indicates no selection.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeConstraint
TextBox.SizeConstraint: Enum.SizeConstraint = Enum.SizeConstraint.RelativeXYThe parent axes used to resolve relative interface size.
Text
TextBox.Text: string = ""The text displayed by the element.
TextBounds
TextBox.TextBounds: Vector2The resolved pixel bounds of the rendered text. Read-only.
TextColor3
TextBox.TextColor3: Color3 = Color3.new(0, 0, 0)The color used to render text.
TextEditable
TextBox.TextEditable: boolean = trueWhether the user can edit the TextBox text.
TextFits
TextBox.TextFits: booleanWhether the rendered text fits within the text box's bounds. Read-only.
TextScaled
TextBox.TextScaled: booleanWhether the engine scales the text to fit the text box's bounds.
TextSize
TextBox.TextSize: number = 8The base text size in pixels.
TextStrokeColor3
TextBox.TextStrokeColor3: Color3 = Color3.new(0, 0, 0)The color used for the outline around text glyphs.
TextStrokeTransparency
TextBox.TextStrokeTransparency: number = 1The transparency of the outline around text glyphs.
TextTransparency
TextBox.TextTransparency: number = 0The text transparency, from 0 for opaque to 1 for invisible.
TextTruncate
TextBox.TextTruncate: EnumItemThe truncation mode used when text does not fit.
TextWrapped
TextBox.TextWrapped: boolean = falseWhether text wraps onto additional lines within the element's width.
TextXAlignment
TextBox.TextXAlignment: Enum.TextXAlignment = Enum.TextXAlignment.CenterThe horizontal alignment of text within the element.
TextYAlignment
TextBox.TextYAlignment: Enum.TextYAlignment = Enum.TextYAlignment.CenterThe vertical alignment of text within the element.
Visible
TextBox.Visible: boolean = trueWhether this interface element is rendered.
ZIndex
TextBox.ZIndex: number = 1The element's draw-order index. Interpretation depends on the root's ZIndexBehavior.
Methods
CaptureFocus
TextBox:CaptureFocus(): ()Gives keyboard focus to this interface element.
GetExecutionGroup
TextBox:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
ReleaseFocus
TextBox:ReleaseFocus(): ()Removes keyboard focus from this interface element.
Events
DragBegin
TextBox.DragBegin: RBXScriptSignalFires when pointer dragging of the element begins.
DragStopped
TextBox.DragStopped: RBXScriptSignalFires when pointer dragging of the element ends.
FocusLost
TextBox.FocusLost: RBXScriptSignalFires when the TextBox loses keyboard focus.
Focused
TextBox.Focused: RBXScriptSignalFires when the TextBox gains keyboard focus.
InputBegan
TextBox.InputBegan: RBXScriptSignalFires when input begins over or is dispatched to this interface element.
InputChanged
TextBox.InputChanged: RBXScriptSignalFires when input dispatched to this element changes.
InputEnded
TextBox.InputEnded: RBXScriptSignalFires when input dispatched to this element ends.
MouseWheelBackward
TextBox.MouseWheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward over this element.
MouseWheelForward
TextBox.MouseWheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward over this element.
PointerEntered
TextBox.PointerEntered: RBXScriptSignalFires when a pointer moves onto the text box.
PointerExited
TextBox.PointerExited: RBXScriptSignalFires when a pointer moves off the text box.
PointerMoved
TextBox.PointerMoved: RBXScriptSignalFires when the pointer moves across the text box.
SelectionGained
TextBox.SelectionGained: RBXScriptSignalFires when interface navigation selects this element.
SelectionLost
TextBox.SelectionLost: RBXScriptSignalFires when this element loses interface selection.
Inherited members
- Properties
- CatchesPointer
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
local nameBox = Instance.new("TextBox")
nameBox.Text = "Player name"
nameBox.Focused:Connect(function()
print("editing")
end)