Search for usage in LXR

org::kde::kirigami::OverlayDrawer Class Reference
Inheritance diagram for org::kde::kirigami::OverlayDrawer:

Additional Inherited Members

- Properties inherited from org::kde::kirigami::templates::OverlayDrawer
QtObject __internal
bool animating
bool collapsed
int collapsedSize
bool collapsible
bool drawerOpen
Item handle
string handleClosedToolTip
string handleOpenToolTip
bool handleVisible
bool peeking

Detailed Description

Overlay drawers are used to expose additional UI elements needed for small secondary tasks for which the main UI elements are not needed.

Overlay drawers can be used to create two kinds of components, a modal drawer and an inline drawer. A modal drawer darkens the rest of the application and grabs focus until confirmed, whereas an inline drawer does not.

Unlike an OverlaySheet that appears in the center of the application, an OverlayDrawer can be attached to an edge of the application, usually the top or the bottom edges.

See also
Visit to read more about modal and non-modal drawers.

Example usage:

import QtQuick.Layouts 1.15
import QtQuick.Controls 2.15 as QQC2
import org.kde.kirigami 2.20 as Kirigami
Kirigami.ApplicationWindow {
Kirigami.OverlayDrawer {
id: drawer
edge: Qt.BottomEdge
contentItem: RowLayout {
QQC2.Button {
text: "Close"
onClicked: drawer.close()
pageStack.initialPage: Kirigami.Page {
RowLayout {
QQC2.Button {
text: "Open drawer"
onClicked: {
drawer.modal = isModal.checked
QQC2.CheckBox {
id: isModal
text: "Drawer is modal?"

Definition at line 29 of file OverlayDrawer.qml.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Dec 3 2023 04:02:13 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.