Skip to main content

MultipleOption

Displays a submenu entry linking to a list of options allowing multiple selections.

KeyTypeDescriptionRequiredDefaultMin Version
optionsarray of dictOptions list*
footerTextstringSmall text shown below the optionsLocalizable""
maxCountintegerMax selected itemsINT_MAX
popoverModebooleanUse popover stylefalse1.2-4

Each option dict has:

KeyTypeDescriptionCondition
titlestringOption titleLocalizable
valueprimitiveSaved value; defaults to title if omittedOptional
iconstringOption icon pathOptional
Return TypeDescription
array of primitiveArray of selected option values

Example

{
default = {
"Red";
"Green";
};
label = "Multiple selection";
cell = "MultipleOption";
key = "list-2";
maxCount = 2;
options = {
{ title = "Red"; icon = "res/red.png"; };
{ title = "Green"; icon = "res/green.png"; };
{ title = "Blue"; icon = "res/blue.png"; };
};
popoverMode = false;
footerText = "Select up to two";
};

XUI-MultipleOption-1.png

XUI-MultipleOption-2.png