> ## Documentation Index
> Fetch the complete documentation index at: https://ugcore.urging.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# UgLib.TextUI

> The single on-screen text prompt.

<Badge color="green">Client</Badge> Through ug-lib.

```lua theme={"dark"}
UgLib.TextUI.Show(options)
UgLib.TextUI.Hide()
UgLib.TextUI.IsShown() -> boolean
```

<ResponseField name="options.text" type="string" required>1 to 256 characters. Takes the markup.</ResponseField>
<ResponseField name="options.style" type="UgTextUIStyle" default="Pill">`Keybind` shows `key` in a key cap. `Card` shows it on the side.</ResponseField>
<ResponseField name="options.key" type="string">A key label, up to 16 characters, such as `E`.</ResponseField>

<ResponseField name="options.icon" type="UgIcon" />

<ResponseField name="options.position" type="UgPosition">Defaults to `settings.textUIPosition`.</ResponseField>

* Showing the same options again sends nothing, so calling `Show` every frame is fine. A change updates the prompt in place.
* One prompt at a time across resources: a prompt from another resource replaces yours, and your `IsShown()` turns false.

## Example

See the [Point example](/ug-lib/zone#example).


## Related topics

- [UgLib.Enums](/ug-lib/enums.md)
- [UgLib.Draw](/ug-lib/draw.md)
- [UgLib.Notify](/ug-lib/notify.md)
- [UgLib.String](/ug-lib/string.md)
- [UgLib.Format](/ug-lib/format.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.