SettingsExpander¶

Expandable settings group.

import QWinUI3.Extras · src/extras/QWinUI3/Extras/SettingsExpander.qml

Category: Layout · Library: v2.80

Gallery: SettingsExpander — src/gallery/pages/SettingsExpanderPage.qml

Extends Control.

Example¶

SettingsExpander {
    title: qsTr("Advanced")
    toggle: true
    checked: true
    SettingsCard { title: qsTr("Option"); toggle: true }
}

// --- API ---
// signals: onExpanding, onCollapsing, onToggled

Notes¶

Expander styled as a settings group; header + nested SettingsCard children. Set toggle: true for a built-in Switch (same API as SettingsCard). Default children land in a ColumnLayout (no manual wrapper). See docs/forms.md.

API¶

Properties¶

Name	Type	Description
`title`	`string`	Primary title text
`header`	`alias`	Alias of title (parity with SettingsCard / SettingsGroup)
`description`	`string`	Supporting description text
`symbol`	`var`	FluentIcons symbol (preferred over iconGlyph)
`iconGlyph`	`string`	Raw Fluent glyph string fallback
`headerIcon`	`var`	Header icon glyph
`expanded`	`bool`	Expanded state
`isExpanded`	`alias`	Alias of expanded
`expandDirection`	`string`	WinUI ExpandDirection: down \| up
`action`	`alias`	Custom action slot; ignored when toggle is true
`toggle`	`bool`	Built-in Switch action (mutually exclusive with action:)
`checked`	`alias`	Switch checked state (when toggle is true)
`toggleEnabled`	`alias`	Switch enabled (when toggle is true)
`toggleText`	`alias`	Optional Switch text
`cornerRadius`	`real`	ElevatedChrome corner radius
`contentSpacing`	`real`	Nested content spacing
`contentData`	`alias`	Default children / content slot (ColumnLayout)
`effectiveHeaderIcon`	`string`	Resolved header icon

Signals¶

Signature	Description
`expanding()`	True while expanding
`collapsing()`	True while collapsing
`toggled(bool checked)`	Emitted when the built-in Switch toggles

Methods¶

No custom methods (use inherited methods from the base type).

Inherited from `Control`¶

Also available (base type / Qt Quick Controls):

padding
font
background / contentItem

Generated from module sources by scripts/generate_component_docs.py — do not edit by hand.