> For the complete documentation index, see [llms.txt](https://framestudio.gitbook.io/framestudio-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://framestudio.gitbook.io/framestudio-documentation/fs-ui/api.md).

# API reference

Client exports: notify, clearNotifications, progressBar, progressCircle, showTextUI, hideTextUI, registerContext, showContext, inputDialog, alertDialog, setTheme, getTheme, getThemes, getLocale.

```lua
-- client
exports.fs_ui:notify({ title = 'Bank', description = 'Paid $500', type = 'success', icon = 'cash' })

local answer = exports.fs_ui:alertDialog({
    header = 'Continue?',
    content = 'This cannot be undone.',
    cancel = true,
})

if answer == 'confirm' then
    local done = exports.fs_ui:progressBar({
        label = 'Working',
        duration = 4000,
        canCancel = true,
        disable = { move = true, combat = true },
    })
end
```

```lua
-- server
exports.fs_ui:notify(source, { title = 'Paid', description = '$500', type = 'success' })
exports.fs_ui:notify(-1, 'Server restarting in 5 minutes')
TriggerClientEvent('fs_ui:notify', source, { description = 'Saved' })
```

Drop-in mode makes this resource answer the UI net events ox\_lib registers, so existing server-side notify and alert calls keep working with no edits. It stays off while ox\_lib is started, so both UIs never draw the same notification.

Export signatures match ox\_lib for notify, progressBar, progressCircle, showTextUI, hideTextUI, registerContext, showContext, inputDialog and alertDialog, so a call site can be pointed here with a search and replace. Behaviour is matched for the documented options, not the full ox\_lib option list.