1// Copyright (C) 2017 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5 \page qtquickcontrols-popups.html
7 \ingroup qtquickcontrols-guidelines
8 \brief Guidelines for popup controls
10 \annotatedlist qtquickcontrols-popups
12 Each type of popup control has its own specific target use case. The
13 following sections offer guidelines for choosing the appropriate type
14 of popup control, depending on the use case.
16 \section1 Drawer Control
18 \image qtquickcontrols-drawer-expanded-wireframe.png
20 \l Drawer provides a swipe-based side panel, similar to those often used
21 in touch interfaces to provide a central location for navigation.
23 The drawer can be positioned at any of the four edges of the screen. It allows
24 the user to add navigation without taking up valuable screen space. The user can
25 show and hide the drawer at any time with a simple swipe movement.
27 \section1 Menu Control
29 \image qtquickcontrols-menu.png
31 The \l Menu control displays a vertical list of items that can be selected. It can
32 be used for offering a list of actions that can be taken in a given context.
34 \b {See also} \l {Drawer Control}.
36 \section1 Popup Control
38 \image qtquickcontrols-popup-settings.png
40 A \l Popup displays content over other application content.
41 It prompts the user to make a decision or enter information.
43 Popups can be modal or non-modal. A modal popup blocks users from interacting
44 with the application until they have made a choice and closed the popup.
46 A popup can be used for:
49 \li communicating a message to the user that they must read and acknowledge.
50 \li displaying an error message.
51 \li prompting the user to make a choice and/or enter a value.
54 \section1 ToolTip Control
56 \image qtquickcontrols-tooltip.png
58 \l ToolTip shows a short piece of text that informs the user of a control's
59 function. It is typically placed above or below the parent control.
63 \li Use a tooltip if a control has little or no descriptive text, or needs
65 \li Use a tooltip only if the information on a particular control is not
66 available elsewhere in the screen.
67 \li Keep the tooltip text short so that it does not cover other content
68 while being displayed.
71 \section1 Related Information
73 \li \l {Qt Quick Controls Guidelines}