Panel - sirinsidiator/ESO-LibAddonMenu GitHub Wiki
Data Table
property |
type |
default |
required |
description |
type |
string |
- |
yes |
The widget type of this control ("panel") |
name |
string |
- |
yes |
"Window Title", or string id or function returning a string |
displayName |
string |
- |
yes |
"My Longer Window Title", or string id or function returning a string (can be useful for long addon names or if you want to colorize it) |
author |
string |
- |
no |
"My Author Name", or string id or function returning a string |
version |
string |
- |
no |
"2.0", or string id or function returning a string |
website |
string |
- |
no |
"https://www.esoui.com/downloads/info7-LibAddonMenu.html", URL of website where the addon can be updated or function |
feedback |
string |
- |
no |
"https://www.esoui.com/portal.php?uid=5815", URL of website where feedback/feature requests/bugs can be reported for the addon |
translation |
string |
- |
no |
"https://www.esoui.com/portal.php?uid=5815", URL of website where translation texts of the addon can be helped with |
donation |
string |
- |
no |
"http://www.esoui.com/downloads/info7-LibAddonMenu.html", URL of website where a donation for the addon author can be raised |
keywords |
string |
- |
no |
"settings", additional keywords for search filter (it looks for matches in name..keywords..author) |
slashCommand |
string |
- |
no |
"/myaddon", will register a keybind to open to this panel (don't forget to include the slash!) |
registerForRefresh |
boolean |
true |
no |
boolean will refresh all options controls when a setting is changed and when the panel is shown |
registerForDefaults |
boolean |
true |
no |
boolean will set all options controls back to default values |
resetFunc |
function |
- |
no |
function() print("defaults reset") end, -- custom function to run after settings are reset to defaults |
Examples
local panelData = {
type = "panel",
name = "Window Title",
displayName = "Longer Window Title",
author = "Seerah",
version = "1.3",
slashCommand = "/myaddon", --(optional) will register a keybind to open to this panel
registerForRefresh = true, --boolean (optional) (will refresh all options controls when a setting is changed and when the panel is shown)
registerForDefaults = true, --boolean (optional) (will set all options controls back to default values)
}