CreateRipple

What it does

This compatibility method behaves like CreateRippleButton. Creates a button with a ripple press effect. It is kept so scripts written with the older CreateRipple name continue to work.

When to use it

Use it for primary actions that benefit from clear animated click feedback. Prefer CreateRippleButton in new code so the method name matches the current API.

ElementFunction:CreateRipple(RippleConfig)

local Result = Section:CreateRipple({
    Name = "Example",
    Callback = function(value)
        print(value)
    end,
})

Behavior and return value

This alias forwards to CreateRippleButton, so its options, callbacks, and returned value follow the canonical method.

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