# About

> An About box with icon, version, details and links. A native Pyzed component for Python desktop GUIs, with a live preview, code examples and its API.

Source: https://albakore.github.io/pyzed/library/about/

:::tip[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](https://albakore.github.io/pyzed/library/#code-and-tools) · [Full reference →](https://albakore.github.io/pyzed/reference/ui/#about)

**Code:**

```python
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

```python
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

:::note[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

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

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

```python
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](https://albakore.github.io/pyzed/guides/events/) and [Events of every component](https://albakore.github.io/pyzed/library/events/).

## Properties and API

### `ui.about`

```python
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 →](https://albakore.github.io/pyzed/reference/ui/#about)

## Related

- [Modal](https://albakore.github.io/pyzed/library/modal/): A dialog surface with title, content and footer buttons.
- [Shortcuts](https://albakore.github.io/pyzed/library/shortcuts/): A searchable list of key bindings, grouped.