CommandBar¶

Primary/secondary command row (AppBar host).

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

Category: Buttons & commands · Library: v2.80

Gallery: CommandBar — src/gallery/pages/CommandBarPage.qml

Extends Control.

Example¶

CommandBar {
    id: commandBar
    AppBarButton { text: qsTr("Add"); symbol: FluentIcons.Add }
    // JS overflow (compat):
    // overflowItems / secondaryCommands: [{ text, triggered }]
    // Real AppBar secondary host:
    // secondaryCommandsHost: AppBarButton { text: qsTr("Find"); … }
}

// --- API ---
// signals: onOpening, onClosing, onOpened, onClosed, onMoreButtonClicked
// methods: open(), close(), toggle()
// primary: default children → primaryCommands
// secondary: secondaryCommandsHost (AppBar*) and/or overflowItems / secondaryCommands

Notes¶

Primary + secondary AppBar command row; overflow via secondary commands. secondaryCommandsHost accepts AppBarButton / AppBarToggleButton children. secondaryCommands / overflowItems keep the JS [{text, triggered}] API. isDynamicOverflowEnabled moves overflowing primary commands into (…). Product toolbar preset: compact: false; isDynamicOverflowEnabled: true; isToggleButtonVisible: true; defaultLabelPosition: "bottom" — docs/recipes.md. commandAlignment left|center|right|stretch; compact densifies like Edge toolbar. overflowOpensUpward false opens down (top toolbars); auto flips when space is tight. Keyboard: Tab into bar; F10 / Alt+Down opens overflow (…); Esc closes overflow Menu. AppBarButton: set text or Accessible.name; optional keyboardAcceleratorText hint.

API¶

Properties¶

Name	Type	Description
`contentData`	`alias`	Default children / content slot
`primaryCommands`	`alias`	Primary command host
`overflowMenu`	`alias`	Overflow Menu for secondary commands
`overflowItems`	`var`	[{ text: string, triggered: function() }] — MenuItem cannot parent to Menu in Qt 6
`secondaryCommands`	`alias`	Compat alias of overflowItems (JS secondary list)
`secondaryCommandsHost`	`alias`	WinUI-style secondary AppBar elements (hidden host → overflow Menu)
`barSpacing`	`real`	Spacing between commands
`isOpen`	`bool`	Open / visible state
`defaultLabelPosition`	`string`	Default AppBar label position
`closedDisplayMode`	`string`	How labels show when closed
`isMoreButtonVisible`	`bool`	Show overflow (…) button
`isToggleButtonVisible`	`bool`	Show toggle / more button
`isDynamicOverflowEnabled`	`bool`	WinUI IsDynamicOverflowEnabled — move overflowing primary commands into (…)
`commandAlignment`	`string`	Primary command alignment: left \| center \| right \| stretch (default)
`compact`	`bool`	Dense Edge-like toolbar (also follows Theme.density === "compact" when unset path)
`overflowOpensUpward`	`bool`	Prefer opening overflow upward; false = down (typical top toolbar)
`effectiveLabelPosition`	`string`	Resolved label position

Signals¶

Signature	Description
`opening()`	True while opening
`closing()`	True while closing
`opened()`	Emitted when opened
`closed()`	Swipe content closed
`moreButtonClicked()`	Overflow more button clicked

Methods¶

Signature	Description
`open()`	Open / show
`close()`	Close / dismiss
`toggle()`	Toggle checked / expanded state

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.