src/controls/SwipeListItem.qml

0001 /*
0002  *  SPDX-FileCopyrightText: 2010 Marco Martin <notmart@gmail.com>
0003  *
0004  *  SPDX-License-Identifier: LGPL-2.0-or-later
0005  */
0006
0007 import "private" as P
0008 import "templates" as T
0009
0010 /**
0011  * An item delegate that shows actions on the right side, which are, on mobile mode,
0012  * obtainable by dragging away the item with the handle. If the app is not in mobile mode,
0013  * the actions are always shown to the user.
0014  *
0015  * Example usage:
0016  * @code{.qml}
0017  * ListView {
0018  *     model: myModel
0019  *     delegate: SwipeListItem {
0020  *         QQC2.Label {
0021  *             text: model.text
0022  *         }
0023  *         actions: [
0024  *              Action {
0025  *                  icon.name: "document-decrypt"
0026  *                  onTriggered: print("Action 1 clicked")
0027  *              },
0028  *              Action {
0029  *                  icon.name: model.action2Icon
0030  *                  onTriggered: //do something
0031  *              }
0032  *         ]
0033  *     }
0034  *
0035  * }
0036  * @endcode
0037  * @see <a href="https://develop.kde.org/hig/components/editing/list">KDE Human Interface Guidelines on List Views and List Items</a>
0038  * @inherit kirigami::templates::SwipeListItem
0039  */
0040 T.SwipeListItem {
0041     id: listItem
0042
0043     background: P.DefaultListItemBackground {}
0044 }