ToggleButton

Checkable button with Fluent chrome.

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

Category: Buttons & commands · Library: v2.80

← Component index

Gallery: ToggleButton — src/gallery/pages/ToggleButtonPage.qml

Extends Button.

Example

ToggleButton {
    id: toggle
    text: qsTr("Bold")
    checkable: true
    onToggled: apply()
}
// --- API ---
// toggle.checked / onToggled

Notes

Checkable accent-capable toggle; checked / onToggled; isThreeState cycles checkState.

API

Properties

Name	Type	Description
symbol	var	FluentIcons symbol (preferred over iconGlyph)
iconGlyph	string	Raw Fluent glyph string fallback
iconSize	real	Icon size in px
isThreeState	bool	WinUI IsThreeState — cycle Unchecked → Checked → PartiallyChecked
checkState	int	Explicit check state (QQC Button does not expose AbstractButton.checkState in QML)
effectiveIconGlyph	string	Resolved glyph string
lightScheme	bool	True in light theme
accented	bool	Use accent chrome

Signals

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

Methods

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

Inherited from Button

Also available (base type / Qt Quick Controls):

• text
• enabled
• flat / highlighted
• clicked()

---

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