> For the complete documentation index, see [llms.txt](https://docs.nighty.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nighty.one/ui-scripting/api-reference/ui-elements/input.md).

# Input

## <mark style="color:green;">class</mark> **UI.Input**

{% hint style="info" %}
This documentation is a work in progress. UI scripting is a new feature, and additional content is still being added. Stay tuned for updates!
{% endhint %}

<table><thead><tr><th width="334">Attribute</th><th>Value</th></tr></thead><tbody><tr><td>label</td><td>any <code>string</code><br><br>Default: <code>None</code></td></tr><tr><td>placeholder</td><td>any <code>string</code><br><br>Default: <code>None</code></td></tr><tr><td>value</td><td>The input value, as a <code>string</code><br><br>Default: <code>None</code></td></tr><tr><td>description</td><td>any <code>string</code><br><br>Default: <code>None</code></td></tr><tr><td>show_clear_button</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>invalid</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>disabled</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>readonly</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>required</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>full_width</td><td><code>True | False</code><br><br>Default: <code>False</code></td></tr><tr><td>error_message</td><td>any <code>string</code><br><br>Default: <code>None</code></td></tr><tr><td>margin</td><td>See <a href="/pages/DTBGfFducdgJJ6exaVF7#margin">Margin</a>.<br><br>Default: <code>"m-0"</code></td></tr><tr><td>visible</td><td>See <a href="/pages/DTBGfFducdgJJ6exaVF7#visible">Visible</a>.<br><br>Default: <code>True</code></td></tr></tbody></table>

### Events

| Event   | Arguments        | Description                               |
| ------- | ---------------- | ----------------------------------------- |
| onInput | value (`string`) | Triggered when typing in the input field. |
