> 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/tab.md).

# Tab

## <mark style="color:green;">class</mark> **Tab**

#### Constructor

```python
# Only required parameters
tab = Tab(name="Custom Tab")

# All parameters
tab = Tab(
    name="Custom Tab",
    icon="users",
    gap: 8,
    title="My Custom Tab"
)
```

<table><thead><tr><th width="381">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td><p>Allowed: <code>string</code><br></p><p>Must be <strong>unique</strong> across the whole UI, cannot be longer than 36 characters</p></td></tr><tr><td>icon </td><td><p>Allowed: <code>string</code><br><br>Icon tab </p><p>Available icons: <a data-mention href="#icons">#icons</a></p></td></tr><tr><td>gap </td><td>See <a href="/pages/DTBGfFducdgJJ6exaVF7#gap">Gap</a><br>Default: <code>6</code><br><br>Spacing between <a href="/pages/rWoFYAdBPKaXJsMvCNM2">CardContainer</a> elements. In most cases you can omit this.</td></tr><tr><td>title </td><td><p>Allowed: <code>string | None</code><br>Default: <code>None</code></p><p></p><p>Displayed at the top of your custom tab, above the cards.</p></td></tr></tbody></table>

#### Methods

<table><thead><tr><th width="257">Method</th><th>Description</th></tr></thead><tbody><tr><td>create_container(type, **kwargs)</td><td>Adds a <a href="/pages/rWoFYAdBPKaXJsMvCNM2">CardContainer </a>to the Tab.</td></tr><tr><td>render()</td><td>Initializes the Tab. Should be called last, after all UI elements, cards, and containers are defined.</td></tr><tr><td>toast(title, description, type)</td><td><p>Displays a toast notification inside the app.<br><br><strong>Parameters</strong>:</p><ul><li><strong>Title</strong>: <code>string</code> | <em>required</em></li><li><strong>Description</strong>: <code>string</code> | <em>required</em></li><li><strong>Type</strong>: <code>"INFO"</code>, <code>"ERROR"</code>, <code>"SUCCESS"</code> |  <em>required</em></li></ul><p>Example:</p><pre class="language-python"><code class="lang-python">tab.toast(type="INFO", title="Hello, World!", description="Welcome from py!")
</code></pre><p></p><p><strong>Note</strong>: The toast will only display if the custom tab is open.</p></td></tr></tbody></table>

#### Icons

<table><thead><tr><th width="133">Image</th><th>String</th></tr></thead><tbody><tr><td><img src="/files/Xl3Hw0gpbK77YPB8Zv7E" alt="" data-size="original"></td><td>report</td></tr><tr><td><img src="/files/rBhjG2UfA91RiGcuiwF5" alt="" data-size="original"></td><td>chart</td></tr><tr><td><img src="/files/mDKTpFdl4adyFGIJ2Hyj" alt="" data-size="original"></td><td>two_way</td></tr><tr><td><img src="/files/9R1MXhdk4jbNubvw89KX" alt="" data-size="original"></td><td>inbox</td></tr><tr><td><img src="/files/ze8b7KFnD6ILU0hOwesi" alt="" data-size="original"></td><td>star</td></tr><tr><td><img src="/files/lOpJjnBN9mCHl9KyNZCU" alt="" data-size="original"></td><td>search</td></tr><tr><td><img src="/files/YVvbVChcBvTotsxOSgXv" alt="" data-size="original"></td><td>variants</td></tr><tr><td><img src="/files/eh1w5MdNniYKN6TGIpHE" alt="" data-size="original"></td><td>message</td></tr><tr><td><img src="/files/1zAnBqOxeClWND9xcBJF" alt="" data-size="original"></td><td>users</td></tr><tr><td><img src="/files/5KOQ8KZbafwYWiemG49z" alt="" data-size="original"></td><td>history</td></tr><tr><td><img src="/files/a3ERXIkoPWPhKJmgY5jn" alt="" data-size="original"></td><td>clean</td></tr><tr><td><img src="/files/MWoUEPRcjyS2p8zqGXJg" alt="" data-size="original"></td><td>magic</td></tr><tr><td><img src="/files/GtKvga3P2hbmkWvhlyZk" alt="" data-size="original"></td><td>eraser</td></tr><tr><td><img src="/files/CgX0qbzis8ZqvX1hSfE9" alt="" data-size="original"></td><td>convert</td></tr><tr><td><img src="/files/a87oiOOy5Q6qQ1SFu2VX" alt="" data-size="original"></td><td>cloud</td></tr><tr><td><img src="/files/0ZwVzFiv7bNL9XfYylzM" alt="" data-size="original"></td><td>calc</td></tr><tr><td><img src="/files/hXEKpxi7d0RpFRzs4O3p" alt="" data-size="original"></td><td>calendar</td></tr><tr><td><img src="/files/pSYijXtcKaQD7ECmQuin" alt="" data-size="original"></td><td>key</td></tr><tr><td><img src="/files/vauXsj6xFzJQsv1Vytzy" alt="" data-size="original"></td><td>gift</td></tr><tr><td><img src="/files/hWnzKI4SdptAzFzHO5nK" alt="" data-size="original"></td><td>trophy</td></tr><tr><td><img src="/files/JMNifLUHANrFX7paDDkN" alt="" data-size="original"></td><td>book</td></tr><tr><td><img src="/files/skoKyBsGuTMvcQrciZJ7" alt="" data-size="original"></td><td>sun</td></tr><tr><td><img src="/files/UrnACoP1FLNlQkmbrhF1" alt="" data-size="original"></td><td>cart</td></tr><tr><td><img src="/files/3qzo3XW3TJELDQXSm4fn" alt="" data-size="original"></td><td>pill</td></tr><tr><td><img src="/files/izIUXLhS0A9LHUbLkIIx" alt="" data-size="original"></td><td>bookmark</td></tr><tr><td><img src="/files/D6iHtsEYgvOUsFQwK1A4" alt="" data-size="original"></td><td>mail</td></tr><tr><td><img src="/files/CiLous51l1eHPuocTmBu" alt="" data-size="original"></td><td>bear</td></tr><tr><td><img src="/files/Ov5AAGRBz4eVRXPnugLM" alt="" data-size="original"></td><td>heart</td></tr><tr><td><img src="/files/FtKnIJ3tx8NuVrmURqCD" alt="" data-size="original"></td><td>music</td></tr><tr><td><img src="/files/lgYBYIHI7B9BbyVrgVlY" alt="" data-size="original"></td><td>umbrella</td></tr><tr><td><img src="/files/FXCSomtMdicDAZRCe9nJ" alt="" data-size="original"></td><td>tube</td></tr><tr><td><img src="/files/O5aI4JJuUuSNFKIgjk1G" alt="" data-size="original"></td><td>palette</td></tr><tr><td><img src="/files/gCVriw8Xg5hZZhkY1RLI" alt="" data-size="original"></td><td>lock</td></tr><tr><td><img src="/files/i97ogoVcNia5JYpnMuGr" alt="" data-size="original"></td><td>fire</td></tr><tr><td><img src="/files/mMzLxW8Exxn0yg4y2I86" alt="" data-size="original"></td><td>preferences</td></tr><tr><td><img src="/files/Zi6KYwSXYyfImNNeAoZH" alt="" data-size="original"></td><td>power</td></tr><tr><td><img src="/files/7NpeUyDH8rg4XUXPwVpf" alt="" data-size="original"></td><td>share</td></tr><tr><td><img src="/files/XHP8Csldc4zfPaZpwhl2" alt="" data-size="original"></td><td>bell</td></tr><tr><td><img src="/files/KyaFHy4WBL3cVRdL6Pd5" alt="" data-size="original"></td><td>trash</td></tr><tr><td><img src="/files/XfA32CSX4yUKgrbq2C30" alt="" data-size="original"></td><td>nitro</td></tr></tbody></table>