CreateScrollHint

What it does

Creates a hint that can prompt or automatically perform a scroll action.

When to use it

Use it when more content exists below the visible area and users may not notice it.

ElementFunction:CreateScrollHint(HintConfig)

local LiveScrollHint = LeftGroup:CreateScrollHint({
    Text = "Scroll to see more",
    Icon = "arrow-down",
    AutoScroll = true,
    ScrollAmount = 220,
    AutoStart = true,
    Callback = function(text)
        print("scroll hint", text)
    end
})

Behavior and return value

Store the returned controller or object when later code needs to update its state, call its methods, or close it.

Fields marked optional may be omitted. XLQP then uses the method’s built-in default or leaves that feature disabled.

Related reference

• All element options
• Controller methods
• Full example