logoWindUI Shiny

Button Keybind

Clickable row combined with assignable key trigger.

Button Keybind

ButtonKeybind combines a clickable row + assignable key trigger that runs a callback.

Create

local BK = MainTab:ButtonKeybind({
    Title = "Quick Action",
    Desc = "Click row or press key",
    Icon = "mouse-pointer-click",
    IconThemed = true,
    Color = "Accent",
    Justify = "Between",
    IconAlign = "Right",
    Value = Enum.KeyCode.F,
    CanChange = true,
    Locked = false,
    Callback = function(trigger)
        print("Action triggered by:", trigger)
    end,
})

Config

KeyTypeDefault
Titlestring"Button Keybind"
Descstring?nil
Iconstring"mouse-pointer-click"
IconThemedbooleanfalse
Colorstring | Color3?nil
Justifystring"Between"
IconAlign"Left" | "Right""Right"
Lockedbooleanfalse
LockedTitlestring?nil
Callbackfunctionempty function
ValueEnumItem | string"F"
CanChangebooleantrue
Size"Small" | "Default" | "Large""Default"

Methods

MethodSignatureDescription
LockBK:Lock()Locks interaction
UnlockBK:Unlock()Unlocks interaction
SetBK:Set(keyOrEnum)Sets current trigger key
SetTitleBK:SetTitle(text)Updates visible title
SetDescBK:SetDesc(text)Updates visible description
HighlightBK:Highlight()Brief highlight animation

Full Example (All Button Keybind Methods)

local BK = MainTab:ButtonKeybind({
    Title = "Quick Action",
    Desc = "Default key: F",
    Value = "F",
    CanChange = true,
    Callback = function(trigger)
        print("ButtonKeybind callback:", trigger or "MouseClick")
    end,
})

BK:Set("MouseRight")
BK:SetTitle("Quick Action Key")
BK:SetDesc("Right mouse now triggers action")
BK:Highlight()

BK:Lock()
task.wait(0.5)
BK:Unlock()

On this page