Modern UI

List menus are compact, keyboard-only menus navigated with the arrow keys - a modern drop-in replacement for ox_lib’s lib.registerMenu/lib.showMenu with the same callbacks, indices, and keybinds. Rows can side-scroll through values, toggle checkboxes, and display progress bars, with a built-in description panel and contextual key hints.

Looking for the mouse-driven menu with submenus and hover metadata? That’s the Menu component. The list menu is its keyboard-only sibling: flat, single-level, and driven entirely by arrow keys.

Quick Start

exports.lation_ui:registerListMenu({
    id = 'vehicle_settings',
    title = 'Vehicle Settings',
    subtitle = 'Sultan RS',
    icon = 'fas fa-sliders',
    options = {
        {
            label = 'Radio Station',
            icon = 'fas fa-radio',
            description = 'Scroll through available stations',
            values = { 'Non-Stop-Pop', 'Los Santos Rock', 'WCTR' },
            defaultIndex = 2
        },
        {
            label = 'Lock Doors',
            icon = 'fas fa-lock',
            description = 'Toggle the vehicle door locks',
            checked = true
        },
        {
            label = 'Start Driving',
            icon = 'fas fa-gauge-high',
            description = 'Head to the first waypoint',
            args = { waypoint = 1 }
        }
    }
}, function(selected, scrollIndex, args, checked)
    print('Confirmed option', selected, scrollIndex, checked)
end)

exports.lation_ui:showListMenu('vehicle_settings')

Functions

registerListMenu

exports.lation_ui:registerListMenu(menuData, cb)

Parameters:

menuData (table) - Menu configuration object (see Registration Options)
cb (function, optional) - Called when an option is confirmed with Enter: cb(selected, scrollIndex, args, checked)

showListMenu

Display a previously registered list menu.

exports.lation_ui:showListMenu(menuId, startIndex)

Parameters:

menuId (string) - Unique identifier of the menu to display
startIndex (number, optional) - 1-based option to highlight on open

hideListMenu

Hide the currently displayed list menu.

exports.lation_ui:hideListMenu(onExit)

Parameters:

onExit (boolean, optional) - true also fires the menu’s onClose callback

setListMenuOptions

Replace a registered menu’s options - a single option (with index) or all of them.

exports.lation_ui:setListMenuOptions(menuId, options, index)

Parameters:

menuId (string) - Unique identifier of the menu to update
options (table) - A single option (when index is given) or an array of options
index (number, optional) - 1-based option index to replace

If the menu is currently open, the change applies live - no re-register or re-open needed. The player’s selection is kept.

getOpenListMenu

Get the ID of the currently open list menu.

local menuId = exports.lation_ui:getOpenListMenu()

Returns:

menuId (string | nil) - The ID of the currently open list menu, or nil if none is open

Keyboard Controls

Key	Action
`↑` / `↓`	Move the selection (wraps around, skips disabled options)
`←` / `→`	Scroll through an option’s `values` (wraps around)
`Enter`	Confirm the selected option, or toggle a checkbox option in place
`Home` / `End`	Jump to the first / last option
`ESC` / `Backspace`	Close the menu (blocked when `canClose = false`)

While a list menu is open the cursor stays hidden and the player keeps game input (walking, driving) unless disableInput = true. Firing, the weapon wheel, and melee are always disabled.

Configuration

Registration Options

string

required

Unique menu identifier

title

string

required

Menu title (supports markdown)

subtitle

string

Menu subtitle (supports markdown)

icon

string

FontAwesome icon class or image URLSupported image formats: .png, .webp, .jpg, .jpeg, .gif, .svg

iconColor

string

default:"#9CA3AF"

Icon color (hex or CSS color name)

iconAnimation

string

Icon animation: 'spin', 'spinPulse', 'spinReverse', 'pulse', 'beat', 'fade', 'beatFade', 'bounce', 'shake'

position

string

default:"top-left"

Menu position. Available options: 'top-left', 'top-right', 'bottom-left', 'bottom-right'

canClose

boolean

default:"true"

Whether the menu can be closed with ESC/Backspace

disableInput

boolean

default:"false"

true freezes game input while the menu is open (by default the player keeps moving control)

onClose

function

Called when the menu is closed by the player: onClose(keyPressed) where keyPressed is 'Escape', 'Backspace', or nil when closed via hideListMenu(true)

onSelected

function

Called when the highlighted option changes: onSelected(selected, secondary, args)secondary is the 1-based scroll index on a values option, or the checked state on a checkbox option

onSideScroll

function

Called when a values option is scrolled: onSideScroll(selected, scrollIndex, args)

onCheck

function

Called when a checkbox option is toggled: onCheck(selected, checked, args)

options

table

required

Array of menu options (see Option Properties)

Option Properties

label

string

required

Option display text (supports markdown)

icon

string

FontAwesome icon class or image URLSupported image formats: .png, .webp, .jpg, .jpeg, .gif, .svg

iconColor

string

default:"#9CA3AF"

Icon color (hex or CSS color name)

iconAnimation

string

Icon animation typeAvailable options: 'spin', 'spinPulse', 'spinReverse', 'pulse', 'beat', 'fade', 'beatFade', 'bounce', 'shake'

description

string

Shown in the description panel below the list while this option is selected (supports markdown)

values

table

Makes the option side-scrollable with ←/→ (see Values)

defaultIndex

number

default:"1"

1-based initial scroll index for a values option

checked

boolean

Makes the option a checkbox toggled in place with Enter. Set true or false for the initial state - the presence of the field is what creates the checkbox

progress

number

Progress bar value (0-100) rendered under the label

progressColor

string

default:"#3B82F6"

Progress bar color (hex or CSS color name)

Can also use colorScheme as an alias

disabled

boolean

default:"false"

Rendered dimmed and skipped by keyboard navigation

boolean

default:"true"

Whether confirming this option closes the menu (false keeps it open)

args

table

Arguments passed to the confirm callback and events

onSelect

function

Callback executed when the option is confirmed: onSelect(selected, scrollIndex, args)

event

string

Client event to trigger when the option is confirmed

serverEvent

string

Server event to trigger when the option is confirmed

Values

Each entry in values is either a plain string or an object with its own description, which replaces the option’s description while that value is selected:

values = {
    'Non-Stop-Pop',
    'Los Santos Rock',
    { label = 'WCTR', description = 'Talk radio - West Coast Talk Radio' }
}

Behavior Notes

Live updates - setListMenuOptions applies to an open menu immediately, keeping the player’s selection.
State persistence - scroll positions and checkbox states are remembered when a menu is closed and re-shown. Re-register the menu to reset them.
Switching menus - calling showListMenu while another list menu is open switches directly without firing the first menu’s onClose.

Migrating from ox_lib

The API is deliberately signature-compatible with ox_lib’s list menu - same 1-based indices, same callbacks, same keybinds:

ox_lib	lation_ui
`lib.registerMenu(data, cb)`	`exports.lation_ui:registerListMenu(data, cb)`
`lib.showMenu(id, startIndex)`	`exports.lation_ui:showListMenu(id, startIndex)`
`lib.hideMenu(onExit)`	`exports.lation_ui:hideListMenu(onExit)`
`lib.setMenuOptions(id, options, index)`	`exports.lation_ui:setListMenuOptions(id, options, index)`
`lib.getOpenMenu()`	`exports.lation_ui:getOpenListMenu()`

Using our ox_lib fork? lib.registerMenu and friends forward to the list menu automatically while lation_ui is running - existing scripts need no changes at all.

Weed

Coke

Meth

Chop Shop

Shops Creator

Money Laundering

Metal Detecting

Scuba Diving

Drug Sales

Modern UI - List Menu

Quick Start

Functions

Keyboard Controls

Configuration

Registration Options

Option Properties

Values

Behavior Notes

Migrating from ox_lib

Preview

​Quick Start

​Functions

​Keyboard Controls

​Configuration

​Registration Options

​Option Properties

​Values

​Behavior Notes

​Migrating from ox_lib

​Preview

Quick Start

Functions

Keyboard Controls

Configuration

Registration Options

Option Properties

Values

Behavior Notes

Migrating from ox_lib

Preview