Skip to content
remosito edited this page Jun 7, 2022 · 7 revisions

The header control is used to separate sections of your settings menu. It shows text formatted as a header with a divider above.

A sample header control

Data Table

property type required description
type string yes The widget type of this control ("header")
name number, string, function yes The text to display for the header
width string no "full" or "half" width in the panel
helpUrl string, function no A string URL "https://www.esoui.com", or a function that returns one
reference string no A unique global reference to the control
tooltip number, string, function no The tooltip to display for the Header

Exposed Methods

control:UpdateValue()

This method updates the name of the header with changes in its data table.

Examples

LAM:RegisterOptionControls(panelName, {
	{
		type = "header",
		name = "My Header",
		reference = "MyAddonHeader"
	}
})
local controls = {}
controls[#controls + 1] = {
	type = "header",
	name = "My Other Header",
	width = "half"
}
LAM:RegisterOptionControls(panelName, controls)