Skip to content

Dashboard

R41z0r edited this page Jun 13, 2026 · 1 revision

Contents

Dashboard content is provided through opts.dashboard. It can be a table or a function returning a table.

Field Type Description
hero table Main dashboard title/subtitle/icon.
cards table Quick navigation cards.
status table Status tile configuration.
features table Enabled/customized feature lists.
newEntries table New-in-version list.
dashboard = function(appInstance)
  return {
    hero = {
      title = "My Addon Settings",
      subtitle = "Configure features and profiles.",
      iconKey = "dashboard",
    },
    cards = {
      {
        title = "Quick Reference",
        description = "Commands and usage notes.",
        iconKey = "help",
        pageID = "help.quick-reference",
      },
    },
    status = {
      title = STATUS or "Status",
      tiles = function(_, stats)
        return {
          {
            title = "Customized",
            value = tostring(stats.customized or 0),
            atlas = "worldquest-tracker-questmarker",
          },
        }
      end,
    },
  }
end

Wiki
  • Home
  • Architecture
  • Vendoring
  • Quick Start
  • Field Glossary
  • Troubleshooting
  • Validation

Reference
  ⚬ Config API
  ⚬ UI API
  ⚬ Elements
  ⚬ Examples

Elements
  Structure
   • Category
   • Page
   • Group
   • Dashboard
   • InfoPage
   • Custom
  Controls
   • Toggle
   • CheckboxDropdown
   • Dropdown
   • MultiDropdown
   • SoundDropdown
   • Input
   • Slider
   • Button
  Advanced
   • ColorPicker
   • ColorPalette
   • ColorOverrides
   • ReorderList
   • Expandable
   • Notes

Examples
  Start
   • Minimal Addon
   • Complete Settings Center
   • Wrapper Bridge Pattern
  Data and Behavior
   • Dependent Controls
   • Nested Database Values
   • Dynamic Dropdowns
   • Runtime Refresh
   • Search and New Badges
   • Custom Hosted Editors
  Polish
   • Support Links
   • Theme Colors
   • Theme Borders

Clone this wiki locally