feat(StatusWizardStepper): Adding component documentation (#618)
Part of #616
This commit is contained in:
parent
83955adb6f
commit
191c759407
Binary file not shown.
After Width: | Height: | Size: 49 KiB |
|
@ -38,5 +38,6 @@
|
||||||
\li \l{StatusMessageDetails}
|
\li \l{StatusMessageDetails}
|
||||||
\li \l{StatusTagSelector}
|
\li \l{StatusTagSelector}
|
||||||
\li \l{StatusToastMessage}
|
\li \l{StatusToastMessage}
|
||||||
|
\li \l{StatusWizardStepper}
|
||||||
\endlist
|
\endlist
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -6,10 +6,40 @@ import StatusQ.Core 0.1
|
||||||
import StatusQ.Controls 0.1
|
import StatusQ.Controls 0.1
|
||||||
import StatusQ.Core.Theme 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 {
|
Item {
|
||||||
id: wizardWrapper
|
id: wizardWrapper
|
||||||
width: parent.width
|
width: parent.width
|
||||||
height: 56
|
height: 56
|
||||||
|
/*!
|
||||||
|
\qmlproperty ListModel StatusWizardStepper::stepsModel
|
||||||
|
This property represents all steps and their descriptions as provided by the user.
|
||||||
|
*/
|
||||||
property ListModel stepsModel: ListModel { }
|
property ListModel stepsModel: ListModel { }
|
||||||
|
|
||||||
ListView {
|
ListView {
|
||||||
|
|
Loading…
Reference in New Issue