TextButton

Read Only

Not Replicated

Read Parallel

This property provides a copy of Text that contains exactly what is being rendered by the TextButton. This is useful for eliminating style tags used for rich text markup; for example, when RichText is enabled, the ContentText property shows the text as it appears to the user.

RichText	Text	ContentText
false	<b>Hello,<br/> world!</b>	<b>Hello,<br/> world!</b>
true	<b>Hello,<br/> world!</b>	Hello, world!

Font

Enum.Font

Hidden

Not Replicated

Read Parallel

This property selects one of several pre-defined fonts with which the TextButton will render its text. Some fonts have bold, italic and/or light variants.

With the exception of the Enum.Font.Legacy font, each font will render text with the line height equal to the TextSize property.

The Enum.Font.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, where the width of each character is approximately half the TextSize property.

This property is kept in sync with the FontFace property.

Code Samples

This code sample renders a list of all the available fonts.

Show All Fonts

local frame = script.Parent

-- Create a TextLabel displaying each font
for _, font in pairs(Enum.Font:GetEnumItems()) do
	local textLabel = Instance.new("TextLabel")
	textLabel.Name = font.Name
	-- Set the text properties
	textLabel.Text = font.Name
	textLabel.Font = font
	-- Some rendering properties
	textLabel.TextSize = 24
	textLabel.TextXAlignment = Enum.TextXAlignment.Left
	-- Size the frame equal to the height of the text
	textLabel.Size = UDim2.new(1, 0, 0, textLabel.TextSize)
	-- Add to the parent frame
	textLabel.Parent = frame
end

-- Layout the frames in a list (if they aren't already)
if not frame:FindFirstChildOfClass("UIListLayout") then
	local uiListLayout = Instance.new("UIListLayout")
	uiListLayout.Parent = frame
end

FontFace

Enum.Font

Read Parallel

This property is similar to the Font property but allows setting fonts that don't exist in Enum.Font.

This property is kept in sync with the Font property, such that when setting FontFace, the font is set to the corresponding Enum.Font value or to Enum.Font.Unknown if there are no matches.

LineHeight

Read Parallel

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 TextButton. Valid values range from 1.0 to 3.0, defaulting to 1.0.

LocalizedText

Hidden

Read Only

Not Replicated

Read Parallel

This property sets whether a TextButton should regard GuiBase2d.Localize or not.

MaxVisibleGraphemes

Read Parallel

This property controls the maximum number of graphemes (or units of text) that are shown on the TextButton. It is primarily provided as an easy way to create a typewriter effect where the characters appear one at a time.

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

OpenTypeFeatures

Read Parallel

OpenTypeFeaturesError

Read Only

Not Replicated

Read Parallel

RichText

Read Parallel

This property determines whether the TextButton renders its text using rich text markup to style sections of the string in bold, italics, specific colors, and more.

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

Text

Read Parallel

This property determines the text content rendered by the TextButton. The visual properties of the string rendered to the screen is determined by TextColor3, TextTransparency, TextSize, Font, TextScaled, TextWrapped, TextXAlignment and TextYAlignment.

It is possible to render emoji such as 🔒 and other symbols which aren't affected by the 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. Similarly, this property may contain a tab character, but it will render as a space instead.

Code Samples

This code sample creates a fading banner for a TextLabel. It fades text out, chooses a random string (avoiding repetition), and fades back in.

Fading Banner

local TweenService = game:GetService("TweenService")

local textLabel = script.Parent

local content = {
	"Welcome to my game!",
	"Be sure to have fun!",
	"Please give suggestions!",
	"Be nice to other players!",
	"Don't grief other players!",
	"Check out the shop!",
	"Tip: Don't die!",
}

local tweenInfo = TweenInfo.new(1, Enum.EasingStyle.Sine, Enum.EasingDirection.InOut)

local RNG = Random.new()

local fadeIn = TweenService:Create(textLabel, tweenInfo, {
	TextTransparency = 0,
})

local fadeOut = TweenService:Create(textLabel, tweenInfo, {
	TextTransparency = 1,
})

local lastIndex
while true do
	-- Step 0: Fade out before doing anything
	fadeOut:Play()
	task.wait(tweenInfo.Time)

	-- Step 1: pick content that wasn't the last displayed
	local index
	repeat
		index = RNG:NextInteger(1, #content)
	until lastIndex ~= index
	-- Make sure we don't show the same thing next time
	lastIndex = index

	-- Step 2: show the content
	textLabel.Text = content[index]
	fadeIn:Play()
	task.wait(tweenInfo.Time + 1)
end

This code sample demonstrates emoji rendering using the Text property.

Emoji in Text

local textLabel = script.Parent

local moods = {
	["happy"] = "😃",
	["sad"] = "😢",
	["neutral"] = "😐",
	["tired"] = "😫",
}

while true do
	for mood, face in pairs(moods) do
		textLabel.Text = "I am feeling " .. mood .. "! " .. face
		task.wait(1)
	end
end

TextBounds

Vector2

Read Only

Not Replicated

Read Parallel

This read-only property reflects the absolute size of rendered text in offsets, meaning that if you try to fit text into a rectangle, this property would reflect the minimum dimensions of the rectangle you'd need in order to fit the text.

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

TextColor3

Color3

Read Parallel

This property determines the color of all the text rendered by the TextButton element.

Code Samples

This code sample makes a TextLabel or TextButton count backwards from 10, setting the text color as it does so.

Countdown Text

-- Place this code in a LocalScript within a TextLabel/TextButton
local textLabel = script.Parent

-- Some colors we'll use with TextColor3
local colorNormal = Color3.new(0, 0, 0) -- black
local colorSoon = Color3.new(1, 0.5, 0.5) -- red
local colorDone = Color3.new(0.5, 1, 0.5) -- green

-- Loop infinitely
while true do
	-- Count backwards from 10 to 1
	for i = 10, 1, -1 do
		-- Set the text
		textLabel.Text = "Time: " .. i
		-- Set the color based on how much time is left
		if i > 3 then
			textLabel.TextColor3 = colorNormal
		else
			textLabel.TextColor3 = colorSoon
		end
		task.wait(1)
	end
	textLabel.Text = "GO!"
	textLabel.TextColor3 = colorDone
	task.wait(2)
end

TextDirection

Enum.TextDirection

Read Parallel

Enum.TextDirection in which the text is rendered.

TextFits

Read Only

Not Replicated

Read Parallel

A boolean representation of whether the button's text fits within the size of it.

TextScaled

Read Parallel

This property determines whether text is scaled so that it fills the button's entire space. When enabled, TextSize is ignored and TextWrapped is automatically enabled. This property is useful for rendering text elements within BillboardGuis. When this property is used for on-screen UI, it may be helpful to use a UITextSizeConstraint to restrict the range of possible text sizes.

Automatic Sizing

It's recommended that you 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 while maintaining a consistent font size. For more information, see here.

Additionally, it's recommended that you avoid applying both AutomaticSize and TextScaled and to the same TextButton. AutomaticSize determines the maximum amount of available space that a GuiObject can use (in this case, text), while TextScaled uses the available space determined by AutomaticSize to scale the font size up to the maximum font size (100) if there are no size constraints.

TextStrokeColor3

Color3

Read Parallel

This property sets the color of the stroke, or outline, of rendered text. Along with TextStrokeTransparency, it determines the final visual appearance of the text stroke.

As a powerful alternative which supports color gradients, see UIStroke.

TextStrokeTransparency

Read Parallel

This property sets the transparency of the stroke, or outline, of rendered text. Along with TextStrokeColor3, it determines the final visual appearance of the text stroke.

Note that text stroke is multiple renderings of the same transparency, so this property is essentially multiplicative on itself four times over. Therefore, it's recommended to set TextStrokeTransparency to a value in the range of 0.75 to 1 for more a more subtle effect.

As a powerful alternative which supports color gradients, see UIStroke.

TextTransparency

Read Parallel

This property determines the transparency of all the text rendered by the TextButton.

TextTruncate

Enum.TextTruncate

Read Parallel

Controls the truncation of the text displayed in the TextButton.

TextWrapped