Skip to content

Examples

R41z0r edited this page Jun 13, 2026 · 5 revisions

Contents
Example Purpose
Minimal Addon Small direct Config/UI setup.
Complete Settings Center End-to-end sample with dashboard, groups, controls, notes, search aliases, and slash command.
Wrapper Bridge Pattern Addon wrapper helpers over the raw Config/UI APIs.
Dependent Controls Parent/child enablement and visibility.
Dynamic Dropdowns Lists built from runtime data.
Nested Database Values Explicit getters/setters for nested saved-variable tables.
Search and New Badges Search aliases, renamed settings, and new-feature badges.
Runtime Refresh Updating rendered rows after external state changes.
Support Links Discord, GitHub, Ko-fi, website, and support buttons on an info page.
  1. Vendoring
  2. Quick Start
  3. Field Glossary
  4. Elements
  5. Complete Settings Center
  6. Wrapper Bridge Pattern, when the host addon has wrappers
  • Copy the structure, not the placeholder names.
  • Replace MyAddon, MyAddonDB, and feature names with host addon names.
  • Keep assetRoot pointed at the vendored library folder.
  • Keep ids stable and non-localized.
  • Prefer direct key fields for simple DB values.
  • Prefer explicit getters/setters for nested DB values or runtime refresh.
  • Add keywords for old option names or likely user search terms.
  • Do not rebuild the settings frame from dropdown or MultiDropdown click callbacks.

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