10 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ChatInputBarConfiguration

Inherits from: TextChatConfigurations → Instance → Object

Configures properties of the default text chat input bar. It is parented to TextChatService.

Chat UI composition

The default chat UI is composed of two separate elements: the chat window (message list) configured by ChatWindowConfiguration, and the chat input bar configured by this object. Each element reports its own AbsoluteSize and AbsolutePosition independently. To determine the total screen bounds of the entire chat UI, combine values from both configurations by computing the union of the two rectangles.

Inherits from: TextChatConfigurations

Memory category: Instances

Tags: NotCreatable

Code samples: View on Creator Hub (ChatWindowConfiguration-Get-Total-Chat-Bounds).

Properties

Name	Type / Returns	Description
ChatInputBarConfiguration.AbsolutePosition	Vector2	Actual screen position of the default chat input bar in pixels.
ChatInputBarConfiguration.AbsoluteSize	Vector2	Actual screen size of the default chat input bar in pixels.
ChatInputBarConfiguration.AutocompleteEnabled	boolean	Whether to enable autocomplete for the chat input bar.
ChatInputBarConfiguration.BackgroundColor3	Color3	Background color of the default chat input bar.
ChatInputBarConfiguration.BackgroundTransparency	double	Background transparency of the default chat input bar.
ChatInputBarConfiguration.Enabled	boolean	Whether to show the default chat input bar.
ChatInputBarConfiguration.FontFace	Datatype.Font	Font used to render text in the default chat input bar.
ChatInputBarConfiguration.IsFocused	boolean	Whether the default chat input bar is focused or not.
ChatInputBarConfiguration.KeyboardKeyCode	KeyCode	Additional key users can press to trigger focusing on the default chat input bar.
ChatInputBarConfiguration.PlaceholderColor3	Color3	Color of the text of the placeholder text in the default chat input bar.
ChatInputBarConfiguration.TargetTextChannel	TextChannel	A reference to the target `TextChannel`.
ChatInputBarConfiguration.TextBox	TextBox	Reference to a designated `TextBox` instance that sends messages on behalf of the user.
ChatInputBarConfiguration.TextColor3	Color3	Color of the text in default chat input bar.
ChatInputBarConfiguration.TextSize	int64	Size of the text in default chat input bar.
ChatInputBarConfiguration.TextStrokeColor3	Color3	Color of the text stroke for text in default chat input bar.
ChatInputBarConfiguration.TextStrokeTransparency	double	Transparency of the text stroke for text in default chat input bar.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

ChatInputBarConfiguration.AbsolutePosition

Read-only property that provides the screen position of the default chat input bar in pixels. Behaves similarly to GuiBase2d.AbsolutePosition.

This value represents only the input bar portion of the chat UI, not the entire chat interface. To get the total bounds including the message list, see ChatWindowConfiguration.AbsolutePosition and combine both regions.

Field	Value
type	Vector2
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	Unsafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Chat"]

ChatInputBarConfiguration.AbsoluteSize

Read-only property that provides the screen size of the default chat input bar in pixels. Behaves similarly to GuiBase2d.AbsoluteSize.

Field	Value
type	Vector2
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	Unsafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Chat"]

ChatInputBarConfiguration.AutocompleteEnabled

Whether to enable autocomplete for the chat input bar. Set to false to disable autocomplete.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.BackgroundColor3

Background color of the default chat input bar. Default value is Color3.new(25, 27, 29).

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.BackgroundTransparency

Background transparency of the default chat input bar as a number between 0 and 1. This value is multiplied with the user's GuiService.PreferredTransparency to create the effective background transparency used by the chat input bar, which may be more opaque than this value set here. Default value is 0.2.

Field	Value
type	double
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.Enabled

Whether to show the default chat input bar. Set to false to hide.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.FontFace

Font used to render text in the default chat input bar. Default is Font.BuilderSansMedium.

Field	Value
type	Datatype.Font
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.IsFocused

Indicates whether the default chat input bar is focused or not. Useful for firing property changed events so you can implement callback functions that respond to changes in the input bar's focus state.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	Unsafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Chat"]

Code samples: View on Creator Hub (ChatInputBarConfiguration-Typing-Indicator).

ChatInputBarConfiguration.KeyboardKeyCode

Additional key users can press to trigger focusing on the default chat input bar. Useful when you want to have an extra hotkey for focusing in addition to the / key.

Field	Value
type	KeyCode
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.PlaceholderColor3

Color of the text of the placeholder text in the default chat input bar. Default value is Color3.new(178, 178, 178).

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.TargetTextChannel

Determines which TextChannel to use when the user sends a message with the default chat input bar.

Field	Value
type	TextChannel
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.TextBox

Reference to a designated TextBox instance that sends messages on behalf of the user. You can use it to further integrate your custom chat input bar UI into your experience by freely manipulating appearance, location, and layout. When opting to set this property to a custom TextBox, you don't need to write any code for the following behavior:

When a user types a message and presses KeyCode.Return, the message will be sent to ChatInputBarConfiguration.TargetTextChannel.
When a message is sent, TextBox.Text will automatically clear.

For security, some limitations are imposed on the TextBox when it is promoted to ChatInputBarConfiguration.TextBox. Luau code will not be able to:

Change the TextBox.Text property.
Use the TextBox:CaptureFocus() or TextBox:ReleaseFocus() methods.

Field	Value
type	TextBox
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Chat"]

ChatInputBarConfiguration.TextColor3

Color of the text in default chat input bar. Default value is Color3.new(255, 255, 255).

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.TextSize

Size of the text in default chat input bar. Default value is 14.

Field	Value
type	int64
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.TextStrokeColor3

Color of the text stroke for text in default chat input bar. Default value is Color3.new(0, 0, 0).

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

ChatInputBarConfiguration.TextStrokeTransparency

Transparency of the text stroke for text in default chat input bar. Default value is 0.5.

Field	Value
type	double
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Appearance
serialization	{"can_load":true,"can_save":true}
capabilities	["Chat"]

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.