Indicator

In plain words

A small colored dot that tells a state at a glance: green is fine, red is a problem.

A small colored dot. color is a theme token or a hex color and size its diameter.

ui.indicator · Category: Display · Full reference →

Preview

Code

pz.column([
    pz.row([ui.indicator("success"), ui.label("Server running")], spacing=8, align="center"),
    pz.row([ui.indicator("warning"), ui.label("Reconnecting")], spacing=8, align="center"),
    pz.row([ui.indicator("error"), ui.label("Build failed")], spacing=8, align="center"),
    pz.row([ui.indicator(size=10), ui.label("Unsaved changes")], spacing=8, align="center"),
], spacing=10)

When to use

• Next to a name to show presence (online, busy) or a state (running, failed).
• On a tab or list item to mark unsaved changes.

Usage

import pyzed as pz
from pyzed import ui

pz.column([
    pz.row([ui.indicator("success"), ui.label("Server running")], spacing=8, align="center"),
    pz.row([ui.indicator("warning"), ui.label("Reconnecting")], spacing=8, align="center"),
    pz.row([ui.indicator("error"), ui.label("Build failed")], spacing=8, align="center"),
    pz.row([ui.indicator(size=10), ui.label("Unsaved changes")], spacing=8, align="center"),
], spacing=10)

Variants

About these captures

Each capture is recorded by pyzed itself, off-screen at 2x, in One Dark or One Light to match this site’s theme, and cropped to the component so it shows at its real size. The pointer hovers, presses or types into it; a component that does not react to the pointer cycles through a few themes. With reduced motion you see the first frame. Open Code under a capture to see the snippet that draws it; free names such as on_save stand for your own callbacks.

Color

"accent"

Code

ui.indicator()

"success"

Code

ui.indicator("success")

"warning"

Code

ui.indicator("warning")

"error"

Code

ui.indicator("error")

"text_muted"

Code

ui.indicator("text_muted")

"#c678dd"

Code

ui.indicator("#c678dd")

Size

size=6

Code

ui.indicator("success", size=6)

size=10

Code

ui.indicator("success", size=10)

size=14

Code

ui.indicator("success", size=14)

Next to text

Online

Code

pz.row([ui.indicator("success"), ui.label("Ana is online")], spacing=8, align="center")

Unsaved

Code

pz.row([ui.label("notes.py"), ui.indicator(size=8)], spacing=6, align="center")

Events

Indicator has no events of its own: it shows what you give it. Like every widget it also has the 18 common events (click, double_click, right_click, mouse_enter, drag, key_down, resize…), attached with .on(...): see Events and Events of every component.

Properties and API

ui.indicator

indicator(color='accent', *, size=6, theme=None)

A colored dot (status, unsaved changes, presence).

Property	Default	Description
color	"accent"	Token or color.
size	6	Diameter.
theme	None	Theme to use instead of the current one (pyzed.theme.current()).

Full reference →

Related

BadgeA small pill for statuses, versions and counters.

AvatarA round avatar with initials in a collaborator color.