esx_context

esx_context is the mouse-driven context menu of ESX Legacy. Use it for short action lists (an interaction menu, a boss menu) and small forms with text, number or radio inputs. You open it from client code with ESX.OpenContext, which is a wrapper around the esx_context exports.

OverviewCopy Anchor Link

The menu is a single panel. Only one context menu can be open at a time; opening a new one replaces the current one.

ConfigurationCopy Anchor Link

config.lua contains a single global:

Players can rebind the key under Settings > Key Bindings > FiveM ("Preview Active Context").

Debug commands (see Commands) are only registered when Config.EnableDebug in es_extended is true.

FunctionsCopy Anchor Link

All functions are client side and available on the ESX object once you load @es_extended/imports.lua or call exports['es_extended']:getSharedObject(). Every wrapper returns false when esx_context is not running.

ESX.OpenContextCopy Anchor Link

Opens a context menu and gives it mouse and keyboard focus.

ESX.OpenContext(position, elements, onSelect, onClose, canClose)

The menu argument is the internal menu table: menu.eles holds the current elements (including updated inputValues), menu.position the position.

Before the elements reach the UI, ESX.OpenContext strips HTML tags from title, description, label and inputPlaceholder. Use plain text.

local function openGarageMenu()
    local elements = {
        { unselectable = true, icon = 'fas fa-warehouse', title = 'Garage' },
        { icon = 'fas fa-car', title = 'Take out vehicle', name = 'take_out' },
        { icon = 'fas fa-square-parking', title = 'Park vehicle', name = 'park' },
        { disabled = true, icon = 'fas fa-wrench', title = 'Repair', description = 'Mechanics only' },
    }

    ESX.OpenContext('right', elements, function(menu, element)
        if element.name == 'take_out' then
            TriggerServerEvent('my_garage:takeOut')
        elseif element.name == 'park' then
            TriggerServerEvent('my_garage:park')
        end

        ESX.CloseContext()
    end)
end

RegisterCommand('garage', openGarageMenu, false)

ESX.PreviewContextCopy Anchor Link

Shows the menu without taking mouse focus. The player keeps control of the character and can press the preview key (left Alt by default) to focus the menu and click it.

ESX.PreviewContext(position, elements, onSelect, onClose, canClose)

The parameters are the same as ESX.OpenContext. The preview key only works when an onSelect function was passed.

ESX.CloseContextCopy Anchor Link

Closes the open menu, releases focus and calls the onClose callback. Does nothing if no menu is open.

ESX.CloseContext()

ESX.RefreshContextCopy Anchor Link

Replaces the elements and/or the position of the open menu without closing it. Callbacks and canClose stay the same.

ESX.RefreshContext(elements, position)

-- Update a live counter in the open menu
local elements = {
    { unselectable = true, icon = 'fas fa-users', title = 'Players online' },
    { icon = 'fas fa-hashtag', title = tostring(#GetActivePlayers()) },
}

ESX.RefreshContext(elements)

Element fieldsCopy Anchor Link

Any other field you add (for example value or job) is kept on the element and passed back to onSelect.

Form exampleCopy Anchor Link

Input values are written back to menu.eles when the field changes (on blur or Enter for text, on change for number and radio). Read them when the player clicks a submit row:

local function openNameForm()
    local elements = {
        { unselectable = true, icon = 'fas fa-id-card', title = 'Register vehicle' },
        { icon = '', title = 'Plate text', input = true, inputType = 'text', inputPlaceholder = 'ABC 123', name = 'plate' },
        { icon = '', title = 'Seats', input = true, inputType = 'number', inputValue = 2, inputMin = 1, inputMax = 8, name = 'seats' },
        {
            icon = '', title = 'Engine', input = true, inputType = 'radio', name = 'engine', inputValue = 'petrol',
            inputValues = {
                { text = 'Petrol', value = 'petrol' },
                { text = 'Electric', value = 'electric' },
            },
        },
        { icon = 'fas fa-check', title = 'Submit', name = 'submit' },
    }

    ESX.OpenContext('center', elements, function(menu, element)
        if element.name ~= 'submit' then return end

        local values = {}
        for _, ele in ipairs(menu.eles) do
            if ele.input then
                values[ele.name] = ele.inputValue
            end
        end

        if not values.plate or values.plate == '' then
            ESX.ShowNotification('Enter a plate first', 'error')
            return
        end

        TriggerServerEvent('my_registry:register', values)
        ESX.CloseContext()
    end)
end

ExportsCopy Anchor Link

The ESX.* wrappers call these exports. You can use them directly from any client script.

State bagCopy Anchor Link

While a menu is open, LocalPlayer.state['context:active'] is true. Other resources can check it to avoid opening UI on top of the menu:

if LocalPlayer.state['context:active'] then
    return
end

ControlsCopy Anchor Link

CommandsCopy Anchor Link

Common issuesCopy Anchor Link

• ESX.OpenContext returns false and nothing shows: esx_context is not started, or it starts after the resource calling it. Ensure it in server.cfg after es_extended.
• Argument order: onSelect and onClose come before canClose, and RefreshContext takes elements first. Older snippets get both wrong.
• Clicking an input row does nothing: by design. Add a separate submit row.
• HTML in titles disappears: ESX.OpenContext strips tags on purpose.
• Menu stays open after selecting: selecting does not close the menu. Call ESX.CloseContext() in onSelect when you are done.
• Mouse cursor stuck after a script error: if your onSelect errors before closing, focus stays on the UI. Press Escape, or wrap risky code and always call ESX.CloseContext().

RelatedCopy Anchor Link

• Client UI functions
• esx_menu_default for keyboard-driven list menus
• esx_menu_dialog for single text input
• Core resources overview

Frequently asked questions