feat(StatusSeedPhraseInput): Adding component documentation (#617)

Also fixed component's height in demonstration page

Part of #616
This commit is contained in:
Alexandra Betouni 2022-04-07 23:48:43 +03:00 committed by GitHub
parent 20bf5b07a6
commit 9c1edc80db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 43 additions and 4 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

View File

@ -44,5 +44,6 @@
\li \l{StatusWalletColorSelect} \li \l{StatusWalletColorSelect}
\li \l{StatusRegularExpressionValidator} \li \l{StatusRegularExpressionValidator}
\li \l{StatusIntValidator} \li \l{StatusIntValidator}
\li \l{StatusSeedPhraseInput}
\endlist \endlist
*/ */

View File

@ -59,12 +59,13 @@ Column {
Item { Item {
implicitWidth: 480 implicitWidth: 480
implicitHeight: 102 implicitHeight: 82
z: 100000 z: 100000
StatusSeedPhraseInput { StatusSeedPhraseInput {
id: statusSeedInput id: statusSeedInput
anchors.left: parent.left anchors.left: parent.left
anchors.right: parent.right anchors.right: parent.right
height: parent.height
textEdit.input.anchors.leftMargin: 16 textEdit.input.anchors.leftMargin: 16
textEdit.input.anchors.rightMargin: 16 textEdit.input.anchors.rightMargin: 16
textEdit.input.anchors.topMargin: 11 textEdit.input.anchors.topMargin: 11
@ -88,7 +89,6 @@ Column {
label: "Label" label: "Label"
charLimit: 30 charLimit: 30
errorMessage: "Error message" errorMessage: "Error message"
input.clearable: true input.clearable: true
input.valid: false input.valid: false
input.placeholderText: "Placeholder" input.placeholderText: "Placeholder"

View File

@ -40,6 +40,8 @@ import StatusQ.Core.Theme 0.1
} }
\endqml \endqml
\image status_seed_phrase_input.png
For a list of components available see StatusQ. For a list of components available see StatusQ.
*/ */
@ -47,17 +49,53 @@ Item {
id: root id: root
width: 162 width: 162
height: 44 height: 44
/*!
\qmlproperty alias StatusSeedPhraseInput::textEdit
This property is an alias to the StatusInput's textEdit property.
*/
property alias textEdit: seedWordInput property alias textEdit: seedWordInput
/*!
\qmlproperty alias StatusSeedPhraseInput::text
This property is an alias to the StatusInput's text property.
*/
property alias text: seedWordInput.text property alias text: seedWordInput.text
/*!
\qmlproperty string StatusSeedPhraseInput::leftComponentText
This property sets the StatusInput's left component's text.
*/
property string leftComponentText: "" property string leftComponentText: ""
/*!
\qmlproperty ListModel StatusSeedPhraseInput::inputList
This property holds the filtered words list based on the user's
input text.
*/
property ListModel inputList: ListModel { } property ListModel inputList: ListModel { }
/*!
\qmlproperty ListModel StatusSeedPhraseInput::filteredList
This signal is emitted when the user selects a word from
the suggestions list, either by clicking on it or by completing
typing 4 charactersnd passes as a parameter the selected word.
The corresponding handler is \c onDoneInsertingWord
*/
property ListModel filteredList: ListModel { } property ListModel filteredList: ListModel { }
/*!
\qmlsignal doneInsertingWord
This signal is emitted when the user selects a word from the suggestions list
either by mouse click or by typing 4 characters that match and passes as a parameter
the selected word. The corresponding handler is \c onDoneInsertingWord.
*/
signal doneInsertingWord(string word) signal doneInsertingWord(string word)
/* /*!
This signal is emitted when the user pressed a keyboard key and passes as a \qmlsignal keyPressed
This signal is emitted when the user presses a keyboard key and passes as a
parameter the event. The corresponding handler is \c onKeyPressed. parameter the event. The corresponding handler is \c onKeyPressed.
*/ */
signal keyPressed(var event) signal keyPressed(var event)
/*!
\qmlsignal editClicked
This signal is emitted when the user clicks inside the StatusInput.
The corresponding handler is \c onEditClicked
*/
signal editClicked() signal editClicked()
onActiveFocusChanged: { onActiveFocusChanged: {