AppBarToggleButton

Checkable AppBarButton for CommandBar.

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

Category: Buttons & commands · Library: v2.80

← Component index

Gallery: AppBarToggleButton — src/gallery/pages/AppBarToggleButtonPage.qml

Extends IconicButton.

Example

AppBarToggleButton {
    text: qsTr("Pin")
    checkable: true
}

Notes

Checkable AppBarButton for CommandBar toggles. isCompact + keyboardAcceleratorText mirror AppBarButton.

API

Properties

Name	Type	Description
labelPosition	string	bottom | right | collapsed
barLabelPosition	string	Injected by CommandBar (do not parent-walk)
barCompact	bool	Injected by CommandBar.compact — denser icon-only sizing
isCompact	bool	WinUI IsCompact — hide label, icon-only
keyboardAcceleratorText	string	Shortcut hint (WinUI KeyboardAcceleratorText)
effectiveLabelPosition	string	Resolved label position

Signals

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

Methods

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

---

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