For AI agents: the "Reading aid" section on this page contains the raw Markdown source identical to the rendered content, with HTML markup and animations removed. AI is advised to read that section directly to understand the content quickly and with less noise.
# ZufyUI API Reference

> This document covers the entire public API of the ZufyUI framework, **organized by usage category** (not by code/header order).
> Companion reading: [Project README & build](https://github.com/zhc9968/ZufyUI/blob/master/README.en.md).

> **How to read**: this is not just a signature list — each class first explains overall behavior, then each method's side effects, defaults and pitfalls. **You can use it correctly without reading the source.**

> **Two markers used throughout**:
> - **`Pitfall`**: real traps / counter-intuitive behavior — read these first.
> - **`Version`**: the release in which the API or its semantics changed notably (`added`/`changed`/`deprecated`). Current release is **v1.29.1**.
Open the complete source file:View full Markdown

# ZufyUI API Reference

This document covers the entire public API of the ZufyUI framework, organized by usage category (not by code/header order). Companion reading: Project README & build.

How to read: this is not just a signature list — each class first explains overall behavior, then each method's side effects, defaults and pitfalls. You can use it correctly without reading the source.

Two markers used throughout: - Pitfall: real traps / counter-intuitive behavior — read these first. - Version: the release in which the API or its semantics changed notably (added/changed/deprecated). Current release is v1.29.1.

Chapter 1

Conventions

Namespaces, units, lifetime, version & pitfall notation

Chapter 2

Quick start

Minimal program, structure, reading path

Chapter 3

Basic types

Color, Rect, Thickness, Size

Chapter 4

Events & Signals

ZSignal, Connection, cross-thread

Chapter 5

Fonts & Icons

FontSpec, FontManager, Icon

Chapter 6

Element base

UIElement (layout props, cache, events, accessibility, debug)

Chapter 7

Layout system

Layout, ColumnBox, RowBox, GridLayout, Card, Page, PageHost

Chapter 8

Window

Window (create, show, backdrop, title bar, taskbar, DPI, frame rate)

Chapter 9

Basic controls

Label, Button, TextBox, TextEdit, ComboBox

Chapter 10

Selection & input

CheckBox, RadioButton, RadioGroup, ToggleSwitch, Slider, NumberBox

Chapter 11

Progress

ProgressBar, ProgressRing

Chapter 12

Containers & scrolling

ScrollViewer, ScrollBar, SplitView, Drawer, TabView

Chapter 13

Menus & Popups

Menu, MenuItem, MenuWindow, MessageBox

Chapter 14

Data views

ListView, TableView, TreeView, TreeNode (virtualization, hide/filter/visible order)

Chapter 15

Charts

ChartBase, BarChart, LineChart, PieChart (v1.18.0)

Chapter 16

Window extras

Images, tray, system dialogs, app registration

Chapter 17

Drag & Drop, cards

Drag & Drop, Expander, SettingsList (v1.19.0)

Chapter 18

Theme system

Theme (v1.19.0+)

Chapter 19

DSL

Fluent construction (ZufyUIDsl.h, v1.19.4; extended in v1.20.0)

Chapter 20

Accessibility & Debug Channel

UIA + SetDebugEnabled (v1.17.0)

Chapter 21

Version digest

v1.15.0 → v1.29.1

Chapter 22

Pitfall index

Quick lookup by topic

Chapter 23

Appendix

Defaults & signal index

↑