esx_menu_default

esx_menu_default is the classic ESX list menu: a vertical list of buttons and sliders that players navigate with the arrow keys and Enter. It does not take mouse focus, so the player can keep moving while the menu is open. You open it with ESX.UI.Menu.Open('default', ...) from a client script.

OverviewCopy Anchor Link

The resource has no config.lua. Menus are stacked: when you open a second menu, it is shown on top, and closing it brings back the previous one.

ESX.UI.Menu.OpenCopy Anchor Link

ESX.UI.Menu.Open(menuType, namespace, name, data, submit, cancel, change, close)

Returns the menu object (see Menu object).

Menu dataCopy Anchor Link

Element fieldsCopy Anchor Link

Sliders wrap around: pressing Right on the maximum jumps to the minimum and vice versa. Any extra fields you add (for example price) are passed back to your callbacks unchanged.

Callback dataCopy Anchor Link

submit and change receive:

cancel receives only _namespace and _name in data.

Before change runs, the menu writes each element's value and selected state back into menu.data.elements, so menu.data always matches what the player sees.

ExampleCopy Anchor Link

local function openShopMenu()
    local elements = {
        { label = 'Food', unselectable = true, icon = 'utensils' },
        { label = 'Bread', name = 'bread', price = 5, type = 'slider', value = 1, min = 1, max = 20, icon = 'bread-slice' },
        { label = 'Water', name = 'water', price = 3, type = 'slider', value = 1, min = 1, max = 20, icon = 'bottle-water' },
        { label = 'Payment', name = 'payment', type = 'slider', value = 0, options = { 'Cash', 'Bank' }, icon = 'wallet' },
        { label = 'Close', name = 'close', icon = 'xmark', disableRightArrow = true },
    }

    ESX.UI.Menu.Open('default', GetCurrentResourceName(), 'shop', {
        title = '24/7 Shop',
        align = 'top-left',
        elements = elements,
    }, function(data, menu)
        local item = data.current

        if item.name == 'close' then
            return menu.close()
        end

        if item.name == 'payment' then return end

        local payment = menu.data.elements[4].value == 0 and 'money' or 'bank'
        TriggerServerEvent('my_shop:buy', item.name, item.value, payment)
    end, function(data, menu)
        menu.close()
    end)
end

RegisterCommand('shop', openShopMenu, false)

Menu objectCopy Anchor Link

ESX.UI.Menu.Open returns a menu object. The same object is passed as menu to every callback.

menu.update({ name = 'bread' }, { label = 'Bread (sold out)', usable = false })
menu.refresh()

Other menu functionsCopy Anchor Link

These are generic ESX.UI.Menu helpers that work for every menu type (default, dialog, list).

ControlsCopy Anchor Link

All keys are FiveM key mappings, so players can rebind them under Settings > Key Bindings > FiveM.

Keys are ignored while the pause menu is open.

Common issuesCopy Anchor Link

• attempt to index a nil value (global 'xLib'): esx_lib is missing or starts after this resource.
• Menu does not close: submit and cancel never close the menu automatically. Call menu.close().
• Same menu opens twice: ESX.UI.Menu.Open does not check for duplicates. Guard with if ESX.UI.Menu.IsOpen('default', GetCurrentResourceName(), 'shop') then return end or call ESX.UI.Menu.CloseAll() first.
• Changes to elements are not visible: call menu.refresh() after setElement, update or setTitle.
• Untrusted text breaks the menu: label, description and title are rendered as HTML. Escape player names or other user input before you show them.

RelatedCopy Anchor Link

• Client UI functions
• esx_menu_dialog
• esx_menu_list
• esx_context for mouse-driven menus
• esx_lib

Frequently asked questions