Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Footagesus/WindUI/llms.txt

Use this file to discover all available pages before exploring further.

Add a keybind picker to a tab by calling :Keybind({...}). Clicking the element enters a listening mode — the next key or mouse button pressed becomes the new binding. When a bound key is pressed anywhere in the game (and no text box has focus), the Callback fires with the key name string.

​
Parameters

​
Title
string
Label displayed next to the key badge. Defaults to "Keybind" when omitted.
​
Desc
string
Secondary line of text rendered beneath the title.
​
Value
string
Default key name, e.g. "G", "F", "MouseLeft", or "MouseRight". Must match a valid Enum.KeyCode name or the special strings "MouseLeft" / "MouseRight".
​
Flag
string
Identifier used by the config system to save and restore this element’s value between sessions.
​
Callback
function(keyName: string)
Called each time the bound key is pressed. Receives the key name string (e.g. "G").

​
Converting the key name to an EnumItem

The callback delivers a plain string. Convert it to an Enum.KeyCode with: 
Enum.KeyCode[keyName]
This is the pattern used to wire a keybind to Window:SetToggleKey: 
Tab:Keybind({
  Flag = "KeybindTest",
  Title = "Keybind",
  Desc = "Keybind to open ui",
  Value = "G",
  Callback = function(v)
    Window:SetToggleKey(Enum.KeyCode[v])
  end,
})

​
Methods

Programmatically assigns a new key without user interaction. Accepts either a key name string or an EnumItem.
keybind:Set("H")
-- or
keybind:Set(Enum.KeyCode.H)

​
Notes

Clicking the element shows "..." for 0.2 seconds before listening begins. This prevents the click itself from being captured as the new binding.
Mouse buttons are also bindable. The callback will receive "MouseLeft" or "MouseRight" for those cases.

Build docs developers (and LLMs) love

Get started for freeTalk to us