Roblox UtilitiesDevlHub Roblox Documentation

Class

ChatInputBarConfiguration

NotCreatable
Memory category
Instances

Configures properties of the default chat input bar.

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.

Properties 16#

AbsolutePositionVector2Actual screen position of the default chat input bar in pixels.ReadOnlyNotReplicated
AbsoluteSizeVector2Actual screen size of the default chat input bar in pixels.ReadOnlyNotReplicated
AutocompleteEnabledbooleanWhether to enable autocomplete for the chat input bar.ReadSafe
BackgroundColor3Color3Background color of the default chat input bar.ReadSafe
BackgroundTransparencydoubleBackground transparency of the default chat input bar.ReadSafe
EnabledbooleanWhether to show the default chat input bar.ReadSafe
FontFaceDatatype.FontFont used to render text in the default chat input bar.ReadSafe
IsFocusedbooleanWhether the default chat input bar is focused or not.ReadOnlyNotReplicated
KeyboardKeyCodeKeyCodeAdditional key users can press to trigger focusing on the default chat input bar.ReadSafe
PlaceholderColor3Color3Color of the text of the placeholder text in the default chat input bar.ReadSafe
TargetTextChannelTextChannelA reference to the target TextChannel.ReadSafe
TextBoxTextBoxReference to a designated TextBox instance that sends messages on behalf of the user.ReadSafe
TextColor3Color3Color of the text in default chat input bar.ReadSafe
TextSizeint64Size of the text in default chat input bar.ReadSafe
TextStrokeColor3Color3Color of the text stroke for text in default chat input bar.ReadSafe
TextStrokeTransparencydoubleTransparency of the text stroke for text in default chat input bar.ReadSafe

AbsolutePosition: Vector2#

ReadOnlyNotReplicated

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.

AbsoluteSize: Vector2#

ReadOnlyNotReplicated

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

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.AbsoluteSize and combine both regions.

AutocompleteEnabled: boolean#

ReadSafe

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

BackgroundColor3: Color3#

ReadSafe

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

BackgroundTransparency: double#

ReadSafe

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.

Enabled: boolean#

ReadSafe

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

FontFace: Datatype.Font#

ReadSafe

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

IsFocused: boolean#

ReadOnlyNotReplicated

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.

KeyboardKeyCode: KeyCode#

ReadSafe

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.

PlaceholderColor3: Color3#

ReadSafe

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

TargetTextChannel: TextChannel#

ReadSafe

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

TextBox: TextBox#

ReadSafe

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:

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

TextColor3: Color3#

ReadSafe

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

TextSize: int64#

ReadSafe

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

TextStrokeColor3: Color3#

ReadSafe

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

TextStrokeTransparency: double#

ReadSafe

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

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed