Skip to main content

​
Quick Start

exports.lation_ui:registerRadial({
    id = 'my_menu',
    items = {
        {
            label = 'Option 1',
            icon = 'user',
            onSelect = function()
                print('Option 1 selected')
            end
        },
        {
            label = 'Option 2',
            icon = 'car',
            onSelect = function()
                print('Option 2 selected')
            end
        }
    }
})

exports.lation_ui:addRadialItem({
    id = 'my_item',
    label = 'My Menu',
    icon = 'circle',
    menu = 'my_menu'
})

​
Functions

Register a radial submenu with the specified configuration.
exports.lation_ui:registerRadial(radialData)
Parameters:
Add one or more items to the global radial menu.
exports.lation_ui:addRadialItem(item) -- Single item
exports.lation_ui:addRadialItem({item1, item2}) -- Multiple items
Parameters:
  • item (table | table[]) - Single item or array of items (see Item Properties)
Remove an item from the global radial menu.
exports.lation_ui:removeRadialItem(itemId)
Parameters:
  • itemId (string) - Unique identifier of the item to remove
Clear all items from the global radial menu.
exports.lation_ui:clearRadialItems()
Hide the radial menu.
exports.lation_ui:hideRadial()
Enable or disable the radial menu.
exports.lation_ui:disableRadial(state)
Parameters:
  • state (boolean) - true to disable, false to enable
Get the ID of the currently open radial menu.
local menuId = exports.lation_ui:getCurrentRadialId()
Returns:
  • menuId (string | nil) - The ID of the currently open menu, or nil if no menu is open

​
Configuration

​
Registration Options

​
id
string
required
Unique menu identifier
​
items
table
required
Array of menu items (see Item Properties)

​
Item Properties

​
id
string
Unique item identifier (required for global items)
​
label
string
required
Item display text
​
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'
​
iconAnimateOnHover
boolean
default:"false"
If true, icon only animates on hover instead of continuously
​
menu
string
Submenu ID to open
​
progress
number
Progress ring value (0-100)
​
progressColor
string
default:"#3B82F6"
Progress ring color (hex or CSS color name)
​
badge
number | string
Badge text or count
Numbers greater than 99 display as “99”
​
badgeColor
string
default:"#EF4444"
Badge color (hex or CSS color name)
​
readOnly
boolean
default:"false"
Display only, no hover or click
​
keepOpen
boolean
default:"false"
Keep menu open after clicking
​
onSelect
function
Callback function executed when item is selectedParameters:
  • currentMenu (string | nil) - The current menu ID (or nil for global menu)
  • itemIndex (number) - The clicked item’s index
onSelect = function(currentMenu, itemIndex)
	print(currentMenu, itemIndex)
end
Press Z to open/close the global radial menu (will only display when there is at least one item)

​
Preview

Radial Menu Global
Radial Menu Submenu
Radial Menu Submenu