status-im
/
status-qml
mirror of
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

feat(StatusWizardStepper): Adding component documentation (#618) 

Part of #616
This commit is contained in:
Alexandra Betouni 2022-04-06 11:22:15 +03:00 committed by GitHub
parent 1e9cc07e2d
commit 2df3c0a03e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/src/images/status_wizard_stepper.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 49 KiB

1
doc/src/statusqcomponents.qdoc
View File

@ -38,5 +38,6 @@
\li \l{StatusMessageDetails}
\li \l{StatusTagSelector}
\li \l{StatusToastMessage}
\li \l{StatusWizardStepper}
\endlist
*/

30
src/StatusQ/Components/StatusWizardStepper.qml
View File

@ -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 {