Settings group

In plain words

A titled block of settings, like a section of a preferences window.

A titled block of ui.field rows separated by lines, with an optional description, like a settings screen.

ui.settings_group · Category: Data · Full reference →

Preview

Code

pz.container(ui.settings_group("Editor", [
    ui.field("Font size", ui.number_field(14, on_change, suffix="px")),
    ui.field("Soft wrap", ui.switch(True, on_toggle)),
    ui.field("Theme", ui.select(["One Dark", "One Light"], "One Dark", on_select, width=150)),
], description="Editor preferences."), width=460)

When to use

• To organize a preferences screen into sections (Editor, Files, Git…).

Usage

import pyzed as pz
from pyzed import ui

pz.container(ui.settings_group("Editor", [
    ui.field("Font size", ui.number_field(14, on_change, suffix="px")),
    ui.field("Soft wrap", ui.switch(True, on_toggle)),
    ui.field("Theme", ui.select(["One Dark", "One Light"], "One Dark", on_select, width=150)),
], description="Editor preferences."), width=460)

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.

Options

Without description

Code

pz.container(ui.settings_group("Files", [
    ui.field("Autosave", ui.switch(True, on_toggle)),
    ui.field("Trim whitespace", ui.checkbox(False, on_toggle)),
]), width=380)

description=

Code

pz.container(ui.settings_group("Git", [
    ui.field("Inline blame", ui.switch(False, on_toggle)),
], description="Shown in the editor gutter."), width=380)

States and events

end=

Code

pz.container(ui.settings_group("Editor", [ui.field("Wrap lines", ui.switch(True, on_toggle))],
                               end=ui.button("Reset", on_press, size="sm", variant="ghost")), width=420)

Events

Settings group 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.settings_group

settings_group(title, rows, *, description=None, end=None, theme=None)

A titled block of ui.field rows separated by lines, like a settings screen.

Property	Default	Description
title	required	Group title.
rows	required	The rows (usually ui.field).
description	None	Secondary text.
end	None	Widget at the right of the title (a Reset button…).
theme	None	Theme to use instead of the current one (pyzed.theme.current()).

Full reference →

Related

FieldA settings row: title and description left, control right.

AccordionStacked collapsible sections, like the panels of a settings screen.

CardA bordered surface with an optional title and actions.