SwipeControl¶

Swipe-to-reveal actions on content.

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

Category: Other · Library: v2.80

Gallery: SwipeControl — src/gallery/pages/SwipeControlPage.qml

Extends Control.

Example¶

SwipeControl {
    id: swipeControl
    SwipeAction { text: qsTr("Delete") }
    ListTile { title: qsTr("Row") }
}

// --- API ---
// signals: onOpened, onClosed
// methods: close(), openLeft(), openRight()
// swipeControl.close()
// swipeControl.openLeft()
// swipeControl.openRight()

Notes¶

Content + left/right SwipeAction reveal; openLeft/openRight/close. swipeMode: reveal | execute (WinUI SwipeMode). Action rows are clipped to the revealed strip so they stay hidden when closed. Thresholds (2.42): revealThreshold snap · dragThreshold before drag engages. nestedScrollFriendly raises dragThreshold for ListView / Flickable parents. Pair with a visible overflow/menu path — docs/touch-pointer.md (2.42).

API¶

Properties¶

Name	Type	Description
`modeClosed`	`int`	Open-mode constants (not named "closed" — that name is the signal below)
`leftOpen`	`int`	Left actions revealed
`rightOpen`	`int`	Right actions revealed
`content`	`alias`	Content slot / children host
`leftActions`	`alias`	Actions on the left
`rightActions`	`alias`	Actions on the right
`actionWidth`	`real`	Width of each swipe action
`revealThreshold`	`real`	Drag distance to snap open
`dragThreshold`	`real`	Pointer travel before horizontal drag engages (2.42 — nested scroll).
`nestedScrollFriendly`	`bool`	Raise dragThreshold inside vertical scroll parents (2.42).
`effectiveDragThreshold`	`real`	—
`isOpen`	`bool`	Open / visible state
`openMode`	`int`	modeClosed \| leftOpen \| rightOpen
`swipeMode`	`string`	WinUI SwipeMode: reveal \| execute
`maxLeftReveal`	`real`	Max left swipe reveal width
`maxRightReveal`	`real`	Max right swipe reveal width

Signals¶

Signature	Description
`opened(int mode)`	Emitted when opened
`closed()`	Swipe content closed

Methods¶

Signature	Description
`close()`	Close / dismiss
`openLeft()`	Reveal left swipe actions
`openRight()`	Reveal right swipe actions

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.