About

In plain words

The “About this app” box: name, version and links.

An About box: an icon, the app name and version, a description, a few (label, value) details and link buttons.

ui.about · Category: Code and tools · Full reference →

Preview

Code

ui.about("Notes", "1.2.0", "A small notes app built with Pyzed.", icon="notebook-pen",
         details=[("Python", "3.12"), ("Pyzed", "0.4")],
         links=[("Website", on_website), ("GitHub", on_github)])

When to use

• In a ui.modal opened from the Help menu.

Usage

from pyzed import ui

ui.about("Notes", "1.2.0", "A small notes app built with Pyzed.", icon="notebook-pen",
         details=[("Python", "3.12"), ("Pyzed", "0.4")],
         links=[("Website", on_website), ("GitHub", on_github)])

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.

Content

Name and version

Code

ui.about("Notes", "1.2.0")

details=

Code

ui.about("Notes", "1.2.0", "A small notes app.", icon="notebook-pen",
         details=[("Python", "3.12"), ("Pyzed", "0.4")])

links=

Code

ui.about("Notes", "1.2.0", icon="notebook-pen", links=[("Website", on_web), ("GitHub", on_gh)])

Events

About 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.about

about(
    name,
    version='',
    description='',
    *,
    icon='app-window',
    details=(),
    links=(),
    theme=None,
)

An About box: icon, name, version, a description, a few details and link buttons.

Property	Default	Description
name	required	App name.
version	""	Version text.
description	""	One or two sentences.
icon	"app-window"	Lucide icon.
details	()	(label, value) rows.
links	()	(label, on_press) buttons.
theme	None	Theme to use instead of the current one (pyzed.theme.current()).

Full reference →

Related

ModalA dialog surface with title, content and footer buttons.

ShortcutsA searchable list of key bindings, grouped.