promotional bannermobile promotional banner

LibAboutPanel-2.0

Parses ToC and adds About panel to Interface options
<p>Test image showing the ToC contents of SmartRes2. LibAboutPanel-2.0 has been added to the AceConfig options table.</p>

Test image showing the ToC contents of SmartRes2. LibAboutPanel-2.0 has been added to the AceConfig options table.

While the image shows the window skinned by AddonSkins, this is what the About panel looks like using AceConfig-3.0's options tables from the AddOn "RepByZone".

While the image shows the window skinned by AddonSkins, this is what the About panel looks like using AceConfig-3.0's options tables from the AddOn "RepByZone".

Description

LibAboutPanel-2.0

LibAboutPanel-2.0 is a World of Warcraft Lua library for displaying addon metadata in Blizzard's Settings UI or as an AceConfig-3.0-compatible options table. It works with all valid WoW clients.

Requirements

  • Required: LibStub
  • Optional: AceConfig-3.0, if using :AboutOptionsTable()

Quick Usage

For Ace3 addons, embed LibAboutPanel-2.0 when creating your addon object:

local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "LibAboutPanel-2.0")

For non-Ace3 addons, embed the library into your addon object:

LibStub("LibAboutPanel-2.0"):Embed(MyAddon)

Or use it directly:

local LAP = LibStub("LibAboutPanel-2.0")

Create a Blizzard Settings About panel:

MyAddon:CreateAboutPanel("MyAddon")
-- or
LAP:CreateAboutPanel("MyAddon")

Create an AceConfig-3.0-compatible About options table:

options.args.about = MyAddon:AboutOptionsTable("MyAddon")

AboutOptionsTable() only returns the table. Your addon is responsible for registering it with AceConfig-3.0 or embedding it in an existing options table.

Documentation

See WIKI.md for:

  • .pkgmeta integration
  • Ace3 example usage
  • API reference
  • Supported .toc fields
  • Category and localization notes
  • Troubleshooting

Contributing

The LibAboutPanel-2.0 Team

profile avatar
  • 11
    Followers
  • 15
    Projects
  • 3.5M
    Downloads
Donate

More from Sygon_PaulView all