mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-17 05:56:02 +01:00
better documentation layout
- seperated the 2000+ lines in ReadMe.md into seperate files. - useful if things expand - better readability for users - more organised layout
This commit is contained in:
25
documentation/main_functions/input.md
Normal file
25
documentation/main_functions/input.md
Normal file
@@ -0,0 +1,25 @@
|
||||
### input.lua
|
||||
|
||||
This function displays a customizable input dialog for user text or number entry. It supports both simple and complex input structures.
|
||||
|
||||
- **createInput(title, opts)**
|
||||
- Opens a styled input dialog with configurable fields, labels, input types, and validation.
|
||||
- Supports multiple field types including `text`, `number`, `password`, `checkbox`, `color`, `slider`, and more.
|
||||
- **Parameters:**
|
||||
- `title` (`string`): Title displayed at the top of the input box.
|
||||
- `opts` (`table`): A table of fields with attributes like `label`, `name`, `type`, `value`, and more.
|
||||
- **Example:**
|
||||
```lua
|
||||
local userInput = createInput("Enter Details", {
|
||||
{ type = "text", text = "Name", name = "playerName", isRequired = true },
|
||||
{ type = "number", text = "Age", name = "playerAge", min = 18, max = 99 },
|
||||
{ type = "radio", label = "Gender", name = "playerGender", options = {
|
||||
{ text = "Male", value = "male" },
|
||||
{ text = "Female", value = "female" },
|
||||
{ text = "Other", value = "other" },
|
||||
}},
|
||||
})
|
||||
if userInput then
|
||||
print(json.encode(userInput))
|
||||
end
|
||||
```
|
||||
Reference in New Issue
Block a user