diff --git a/ui/StatusQ/doc/src/images/status_wizard_stepper.png b/ui/StatusQ/doc/src/images/status_wizard_stepper.png new file mode 100644 index 0000000000..82c191ace2 Binary files /dev/null and b/ui/StatusQ/doc/src/images/status_wizard_stepper.png differ diff --git a/ui/StatusQ/doc/src/statusqcomponents.qdoc b/ui/StatusQ/doc/src/statusqcomponents.qdoc index 8a27a89436..781b769b18 100644 --- a/ui/StatusQ/doc/src/statusqcomponents.qdoc +++ b/ui/StatusQ/doc/src/statusqcomponents.qdoc @@ -38,5 +38,6 @@ \li \l{StatusMessageDetails} \li \l{StatusTagSelector} \li \l{StatusToastMessage} + \li \l{StatusWizardStepper} \endlist */ diff --git a/ui/StatusQ/src/StatusQ/Components/StatusWizardStepper.qml b/ui/StatusQ/src/StatusQ/Components/StatusWizardStepper.qml index 8f52fa44e6..a14055aba3 100644 --- a/ui/StatusQ/src/StatusQ/Components/StatusWizardStepper.qml +++ b/ui/StatusQ/src/StatusQ/Components/StatusWizardStepper.qml @@ -6,10 +6,40 @@ import StatusQ.Core 0.1 import StatusQ.Controls 0.1 import StatusQ.Core.Theme 0.1 +/*! + \qmltype StatusWizardStepper + \inherits Item + \inqmlmodule StatusQ.Components + \since StatusQ.Components 0.1 + \brief Displays a step sequence provided by the stepsModel. Inherits \l{https://doc.qt.io/qt-5/qml-qtquick-item.html}{Item}. + + The \c StatusWizardStepper steps and their descriptions as provided by the stepsModel. + For example: + + \qml + StatusWizardStepper { + id: wizardStepper + stepsModel: ListModel { + ListElement {description:"Send Request"; loadingTime: 0; stepCompleted: false} + ListElement {description:"Receive Response"; loadingTime: 0; stepCompleted: false} + ListElement {description:"Confirm Identity"; loadingTime: 0; stepCompleted: false} + } + } + \endqml + + \image status_wizard_stepper.png + + For a list of components available see StatusQ. +*/ + Item { id: wizardWrapper width: parent.width height: 56 + /*! + \qmlproperty ListModel StatusWizardStepper::stepsModel + This property represents all steps and their descriptions as provided by the user. + */ property ListModel stepsModel: ListModel { } ListView {