Context Menu

`registerMenu(data)` / `registerContext(data)`

Registers a menu definition. Must be called before openMenu.

Field	Type	Default	Description
id	string	—	Unique menu identifier (also accepts name)
title	string	—	Menu header text
description	string	—	Subtitle text below the header
position	string	'top-right'	'left-center' or 'right-center'
canClose	boolean	true	Whether the player can close with Escape
menu	string	—	Parent menu ID (for back-navigation)
onExit	function	—	Called when the menu is closed
onBack	function	—	Called when navigating back to the parent menu
options / items	table	—	Array of option tables (see below)

Option fields:

Field	Type	Description
title	string	Option label
description	string	Subtitle shown on hover
icon	string	Font Awesome icon name or full class
disabled	boolean	Greys out the option
readOnly	boolean	Shown but not selectable
menu	string	Opens a submenu on select
event	string	Client event to trigger on select
serverEvent	string	Server event to trigger on select
args	any	Passed to event/callback
metadata	table	Key-value details shown in a sidebar
onSelect	function	Callback fired on select: fn(args, item, menu)

exports['amzn_uikit']:registerMenu({
    id = 'my_shop',
    title = 'General Store',
    options = {
        {
            title = 'Buy Water',
            icon = 'droplet',
            onSelect = function(args)
                -- purchase logic
            end,
        },
    },
})

---

`openMenu(id)` / `showContext(id)`

Opens a registered menu by its ID.

exports['amzn_uikit']:openMenu('my_shop')

---

`closeMenu()` / `hideContext()`

Closes the active context menu.

---

`getOpenMenu()` → `string|nil`

Returns the ID of the currently open menu, or nil.

Previews

GLASS