Text UI (client)

Client-only on-screen helper text (ox_lib, lation_ui, okokTextUI, cd_drawtextui, jg-textui, lab-TextUI, zsx_uiv2).

The lab-TextUI adapter ignores options and isTextUIOpen() always returns false.

No server implementation.

showTextUI(text, options?)

Signature: showTextUI(text: string, options?: OxTextUIOptions): void

ParamType
textstring
optionsOxTextUIOptions?
bridge.textui.showTextUI('[E] Open shop', { position = 'right-center' })

hideTextUI()

Signature: hideTextUI(): void

bridge.textui.hideTextUI()

isTextUIOpen() (optional)

Signature: isTextUIOpen(): boolean

| Returns | boolean | | Note | Provider-dependent |

if bridge.textui.isTextUIOpen() then
    bridge.textui.hideTextUI()
end

Types

OxTextUIOptions

FieldType
position'right-center' | 'left-center' | 'top-center' | 'bottom-center' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center'
iconstring | table?
iconColorstring?
keybindstring?
titlestring?