Tab

Represents a Tab in the User Interface

class Tab

Constructor

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

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

name

Allowed: string

Must be unique across the whole UI, cannot be longer than 36 characters

icon

Allowed: string Icon tab

gap

title

Allowed: string | None Default: None

Displayed at the top of your custom tab, above the cards.

Methods

Method
Description

create_container(type, **kwargs)

render()

Initializes the Tab. Should be called last, after all UI elements, cards, and containers are defined.

toast(title, description, type)

Displays a toast notification inside the app. Parameters:

  • Title: string | required

  • Description: string | required

  • Type: "INFO", "ERROR", "SUCCESS" | required

Example:

Note: The toast will only display if the custom tab is open.

Icons

Image
String

report

chart

two_way

inbox

star

search

variants

message

users

history

clean

magic

eraser

convert

cloud

calc

calendar

key

gift

trophy

book

sun

cart

pill

bookmark

mail

bear

heart

music

umbrella

tube

palette

lock

fire

preferences

power

share

bell

trash

nitro

Last updated