Skip to content

feat(radial): add lib.showRadialMenu Docs #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XCal-Dev wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(radial): add lib.showRadialMenu Docs #282

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcad0b2
feat(radial): add lib.showRadialMenu Docs
XCal-Dev Jul 10, 2026
0e75b05
removed example per review
XCal-Dev Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions content/docs/ox_lib/Interface/Client/radial.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,29 @@ Registers a radial sub menu with predefined options.
- onSelect?: `function(currentMenu: string | nil, itemIndex: number)` | `string`
- Function that's ran when a user clicks the item.

## lib.showRadialMenu

Opens a registered radial menu as the root radial menu.

<Tabs items={["Lua", "JS"]}>
<Tab>
```lua
lib.showRadialMenu(id)
```
</Tab>
<Tab>
```ts
import lib from '@overextended/ox_lib/client';

lib.showRadialMenu(id);
```

</Tab>
</Tabs>

- id: string
- Unique menu id from registered radial menus.

## lib.hideRadial

Hides the radial menu if one is open.
Expand Down Expand Up @@ -268,6 +291,15 @@ Here's a use case example with some global options and an option utilising the l
function point:onExit()
lib.removeRadialItem('garage_access')
end

lib.addKeybind({
name = 'urrp_radialmenu_config_demo',
description = 'Open Police menu',
defaultKey = 'F6',
onPressed = function()
lib.showRadialMenu('police_menu')
end,
})
```

</Tab>
Expand Down