ChatInputBarConfiguration
CreatorHub

Configures properties of the default chat input bar.

Instances of this class cannot be created with Instance.new.

Memory category	Instances

Tags: [NotCreatable]

Member index 19

History		Member
726		AbsolutePosition: Vector2
726		AbsolutePositionWrite: Vector2
726		AbsoluteSize: Vector2
726		AbsoluteSizeWrite: Vector2
726		AutocompleteEnabled: bool
726		BackgroundColor3: Color3
726		BackgroundTransparency: double
726		Enabled: bool
726		FontFace: Font
726		IsFocused: bool
726		IsFocusedWrite: bool
726		KeyboardKeyCode: KeyCode
726		PlaceholderColor3: Color3
726		TargetTextChannel: TextChannel
726		TextBox: TextBox
726		TextColor3: Color3
726		TextSize: int64
726		TextStrokeColor3: Color3
726		TextStrokeTransparency: double
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Description

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

History 48
Hide member changes

726 Change Default of TextStrokeTransparency from 0.5 to
726 Change Default of TextStrokeColor3 from Color3(0, 0, 0) to
726 Change Default of TextSize from 14 to
726 Change Default of TextColor3 from Color3(1, 1, 1) to
726 Change Default of TextBox from to
726 Change Default of TargetTextChannel from to
726 Change Default of PlaceholderColor3 from Color3(0.698039, 0.698039, 0.698039) to
726 Change Default of KeyboardKeyCode from Slash to
726 Change Default of IsFocusedWrite from false to
726 Change Default of IsFocused from false to
726 Change Default of FontFace from to
726 Change Default of Enabled from true to
726 Change Default of BackgroundTransparency from 0.2000000000000000111 to
726 Change Default of BackgroundColor3 from Color3(0.0980392, 0.105882, 0.113725) to
726 Change Default of AutocompleteEnabled from true to
726 Change Default of AbsoluteSizeWrite from Vector2(0, 0) to
726 Change Default of AbsoluteSize from Vector2(0, 0) to
726 Change Default of AbsolutePositionWrite from Vector2(0, 0) to
726 Change Default of AbsolutePosition from Vector2(0, 0) to
588 Add AutocompleteEnabled
575 Change Tags of KeyboardKeyCode from [Hidden] to []
575 Change Default of KeyboardKeyCode from to Slash
574 Add KeyboardKeyCode
574 Add IsFocusedWrite
574 Add IsFocused
559 Add TextBox
554 Add TextStrokeTransparency
554 Add TextStrokeColor3
554 Add TextSize
554 Add TextColor3
554 Add PlaceholderColor3
554 Add FontFace
554 Add BackgroundTransparency
554 Add BackgroundColor3
553 Change Default of TargetTextChannel from to
553 Change Default of Enabled from to true
553 Change Default of AbsoluteSizeWrite from to Vector2(0, 0)
553 Change Default of AbsoluteSize from to Vector2(0, 0)
553 Change Default of AbsolutePositionWrite from to Vector2(0, 0)
553 Change Default of AbsolutePosition from to Vector2(0, 0)
540 Add AbsoluteSizeWrite
540 Add AbsoluteSize
540 Add AbsolutePositionWrite
540 Add AbsolutePosition
533 Change Tags of ChatInputBarConfiguration from [NotCreatable, NotBrowsable] to [NotCreatable]
514 Add TargetTextChannel
514 Add Enabled
514 Add ChatInputBarConfiguration

Members 19

AbsolutePosition
CreatorHub

Type		Default
Vector2

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

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	Unsafe
Category	Data
Loaded/Saved	false

History 3

726 Change Default of AbsolutePosition from Vector2(0, 0) to
553 Change Default of AbsolutePosition from to Vector2(0, 0)
540 Add AbsolutePosition

Tags: [ReadOnly, NotReplicated]

AbsolutePositionWrite
CreatorHub

Type		Default
Vector2

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

726 Change Default of AbsolutePositionWrite from Vector2(0, 0) to
553 Change Default of AbsolutePositionWrite from to Vector2(0, 0)
540 Add AbsolutePositionWrite

Tags: [Hidden]

AbsoluteSize
CreatorHub

Type		Default
Vector2

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

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	Unsafe
Category	Data
Loaded/Saved	false

History 3

726 Change Default of AbsoluteSize from Vector2(0, 0) to
553 Change Default of AbsoluteSize from to Vector2(0, 0)
540 Add AbsoluteSize

Tags: [ReadOnly, NotReplicated]

AbsoluteSizeWrite
CreatorHub

Type		Default
Vector2

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

726 Change Default of AbsoluteSizeWrite from Vector2(0, 0) to
553 Change Default of AbsoluteSizeWrite from to Vector2(0, 0)
540 Add AbsoluteSizeWrite

Tags: [Hidden]

AutocompleteEnabled
CreatorHub

Type		Default
bool

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

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 2

726 Change Default of AutocompleteEnabled from true to
588 Add AutocompleteEnabled

BackgroundColor3
CreatorHub

Type		Default
Color3

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of BackgroundColor3 from Color3(0.0980392, 0.105882, 0.113725) to
554 Add BackgroundColor3

BackgroundTransparency
CreatorHub

Type		Default
double

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.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of BackgroundTransparency from 0.2000000000000000111 to
554 Add BackgroundTransparency

Enabled
CreatorHub

Type		Default
bool

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

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 3

726 Change Default of Enabled from true to
553 Change Default of Enabled from to true
514 Add Enabled

FontFace
CreatorHub

Type		Default
Font

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of FontFace from to
554 Add FontFace

IsFocused
CreatorHub

Type		Default
bool

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.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	Unsafe
Category	Data
Loaded/Saved	false

History 2

726 Change Default of IsFocused from false to
574 Add IsFocused

Tags: [ReadOnly, NotReplicated]

IsFocusedWrite
CreatorHub

Type		Default
bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

726 Change Default of IsFocusedWrite from false to
574 Add IsFocusedWrite

Tags: [Hidden]

KeyboardKeyCode
CreatorHub

Type		Default
KeyCode

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.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

726 Change Default of KeyboardKeyCode from Slash to
575 Change Tags of KeyboardKeyCode from [Hidden] to []
575 Change Default of KeyboardKeyCode from to Slash
574 Add KeyboardKeyCode

PlaceholderColor3
CreatorHub

Type		Default
Color3

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of PlaceholderColor3 from Color3(0.698039, 0.698039, 0.698039) to
554 Add PlaceholderColor3

TargetTextChannel
CreatorHub

Type		Default
TextChannel

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

726 Change Default of TargetTextChannel from to
553 Change Default of TargetTextChannel from to
514 Add TargetTextChannel

TextBox
CreatorHub

Type		Default
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.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 2

726 Change Default of TextBox from to
559 Add TextBox

TextColor3
CreatorHub

Type		Default
Color3

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of TextColor3 from Color3(1, 1, 1) to
554 Add TextColor3

TextSize
CreatorHub

Type		Default
int64

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of TextSize from 14 to
554 Add TextSize

TextStrokeColor3
CreatorHub

Type		Default
Color3

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of TextStrokeColor3 from Color3(0, 0, 0) to
554 Add TextStrokeColor3

TextStrokeTransparency
CreatorHub

Type		Default
double

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of TextStrokeTransparency from 0.5 to
554 Add TextStrokeTransparency

Engine API

Website

Related

History 3

History 3

History 3

History 3

History 2

History 2

History 2

History 3

History 2

History 2

History 2

History 4

History 2

History 3

History 2

History 2

History 2

History 2

History 2