org::kde::kirigami::PlaceholderMessage

Properties | |
string | explanation |
alias | helpfulAction |
ActionIconGroup | icon |
string | text |
int | type |
Detailed Description
A placeholder message indicating that a list view is empty.
The message comprises a label with lightened text, an optional icon above the text, and an optional button below the text which can be used to easily show the user what to do next to add content to the view.
The top-level component is a ColumnLayout, so additional components items can simply be added as child items and they will be positioned sanely.
Example usage:
- Since
- 2.12
Definition at line 142 of file PlaceholderMessage.qml.
Property Documentation
◆ explanation
|
read |
explanation: string Smaller explanatory text to show below the larger title-style text
Useful for providing a user-friendly explanation for how to proceed.
Optional; if not defined, the message will have no supplementary explanatory text.
- Since
- 5.80
Definition at line 176 of file PlaceholderMessage.qml.
◆ helpfulAction
|
read |
helpfulAction: QtQuickControls2 Action An action that helps the user proceed.
Typically used to guide the user to the next step for adding content or items to an empty view.
Optional; if undefined, no button will appear below the text label.
- Since
- 5.70
Definition at line 199 of file PlaceholderMessage.qml.
◆ icon
|
read |
icon: QVariant The icon to show above the text label.
Accepts "icon.name" and "icon.source"
Optional; if undefined, the message will have no icon. Falls back to undefined
if the specified icon is not valid or cannot be loaded.
- Since
- 5.70
- See also
- Icon::source
Definition at line 189 of file PlaceholderMessage.qml.
◆ text
|
read |
text: string The text to show as a placeholder label
Optional; if not defined, the message will have no large text label text. If both text: and explanation: are omitted, the message will have no text and only an icon, action button, and/or other custom content.
- Since
- 5.70
Definition at line 164 of file PlaceholderMessage.qml.
◆ type
|
read |
The type of the message.
This can be:
- Kirigami.PlaceholderMessage.Type.Actionable: Makes it more attention-getting. Useful when the user is expected to interact with the message.
- Kirigami.PlaceholderMessage.Type.Informational: Makes it less prominent. Useful when the message in only informational.
By default if an helpfulAction is provided this will be of type Actionable otherwise of type Informational.
- Since
- 5.94
Definition at line 153 of file PlaceholderMessage.qml.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Jul 4 2022 04:09:39 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.