Skip to content

ListDetailsView

Master–detail recipe on TwoPaneView.

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

Category: Collections & data · Library: v2.80

← Component index

Gallery: ListDetailsViewsrc/gallery/pages/ListDetailsViewPage.qml

Extends Control.

Example

ListDetailsView {
    model: []
    titleRole: "title"
    details: Label { text: listDetails.selectedItem.title }
}

// --- API ---
// selectedIndex / selectedItem, select(index), showList(), showDetails()
// listHeader / detailToolbar / details slots; multiSelectEnabled + selectedItems (2.64)
// connectedAnimationEnabled (+ key) — list→detail and reverse on showList() (2.68 B3)

Notes

ListView master + details host. Collapses via TwoPaneView on narrow widths. model items may be strings or objects (titleRole / subtitleRole). Optional filterText filters plain JS arrays (debounced, 1.88). Selection tracks item object across filter rebuilds (2.18). multiSelectEnabled adds checkboxes + detailToolbar for bulk actions (2.64). Keyboard: arrows / Home / End / Enter on the list; Esc (or Back) returns to the list in SinglePane mode. Live-region announces selection / pane changes (2.07).

API

Properties

Name Type Description
model var
titleRole string
subtitleRole string
filterText string
filterRoles var
filterDebounceMs int
maxFilterResults int Cap filtered master rows (0 = unlimited) — 2.18.
selectedIndex int
listPaneWidth real
minWideWidth real
details alias
listHeader alias
detailToolbar alias
multiSelectEnabled bool Master multi-select + bulk toolbar slot (2.64).
connectedAnimationEnabled bool Morph list row → details pane via ConnectedAnimationService
connectedAnimationKey string
accessibleName string Screen-reader name override (1.19)
listAccessibleName string
announceChanges bool Qt 6.8+ Accessible.announce for selection / pane changes (2.07).
itemEnter string Master list enter motion: none | fade | slide — 2.67 B2
itemExit string Master list exit motion: none | fade | slide
selectedItem var
singlePaneDetailsOpen bool
filteredCount int
selectedItems var
selectionCount int

Signals

Signature Description
selectionChanged(int index, var item)
multiSelectionChanged(var items)

Methods

Signature Description
isMultiSelected(item)
toggleMultiSelect(index)
selectAllMulti()
clearMultiSelection()
select(index)
showList()
showDetails()

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.