MaxVisibleGraphemes

Value Type: int

Description:

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

Code Samples

Typewriter Effect with MaxVisibleGraphemes

This example uses TweenService to animate the grapheme count in a typewriter-like fashion.

The final grapheme count comes from a combination of the text object’s ContentText property, which excludes style tags used for rich text, and utf8.len, which returns the grapheme count.

			
				Typewriter Effect with MaxVisibleGraphemes

				Expected Output
			
				Expand
				
			local TweenService = game:GetService("TweenService")

local textObject = script.Parent

local tweenInfo = TweenInfo.new(
	4, -- it takes 4 seconds for the effect to complete
	Enum.EasingStyle.Sine, -- typing starts fast and slows near the end
	Enum.EasingDirection.Out
)

local tween = TweenService:Create(
	textObject,
	tweenInfo,
	{
		-- Final value should be the total grapheme count
		MaxVisibleGraphemes = utf8.len(textLabel.ContentText)
	}
)

tween:Play()
tween.Completed:Wait()

-- Reset the value so it can be tweened again
textObject.MaxVisibleGraphemes = -1
		
				Copy Code
			
				Light Theme