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 text input to a tab by calling :Input({...}). The returned object lets you set its value programmatically.

​
Parameters

​
Title
string
Label displayed above the input field.
​
Desc
string
Secondary line of text rendered beneath the title.
​
Icon
string
Lucide icon shown in the element row (not inside the text field itself).
​
InputIcon
string
Lucide icon rendered inside the left edge of the text field.
​
Type
"Input" | "Textarea"
default:"\"Input\""
"Input" renders a single-line field. "Textarea" renders a taller multi-line box.
​
Value
string
Default text pre-filled in the field.
​
Placeholder
string
Hint text shown when the field is empty.
​
Flag
string
Identifier used by the config system to save and restore this element’s value between sessions.
​
Locked
boolean
When true, the field is disabled and overlaid with a lock indicator.
​
LockedTitle
string
Custom text shown on the lock overlay. Defaults to "Locked".
​
ClearTextOnFocus
boolean
default:"false"
When true, the text field is cleared when the user clicks on it to begin editing.
​
Callback
function(text: string)
Called when the user finishes editing (focus lost). Receives the current text string.

​
Methods

Sets the text field content programmatically.
local nameInput = Tab:Input({
  Title = "Config Name",
  Icon = "file-cog",
  Callback = function(value)
    print("Name:", value)
  end,
})

-- Fill from a dropdown selection
nameInput:Set("default")

​
Examples

​
Basic input with icon

Tab:Input({
  Title = "Input",
  Icon = "mouse",
})

​
Textarea with icon

Tab:Input({
  Title = "Input Textarea",
  Type = "Textarea",
  Icon = "mouse",
})

​
Textarea without icon

Tab:Input({
  Title = "Input Textarea",
  Type = "Textarea",
})

​
Input with description

Tab:Input({
  Title = "Input",
  Desc = "Input example",
})

​
Textarea with description

Tab:Input({
  Title = "Input Textarea",
  Desc = "Input example",
  Type = "Textarea",
})

​
Locked input

Tab:Input({
  Title = "Input",
  Locked = true,
  LockedTitle = "This element is locked",
})

​
Input with Flag (config saving)

Tab:Input({
  Flag = "InputTest",
  Title = "Input",
  Desc = "Input Description",
  Value = "Default value",
  InputIcon = "bird",
  Type = "Input",
  Placeholder = "Enter text...",
  Callback = function(input)
    print("Text entered:", input)
  end,
})
The callback fires on FocusLost, not on every keystroke. If you need live updates, consider using the Flag system and reading the config value when needed.

Build docs developers (and LLMs) love

Get started for freeTalk to us