From 64bb0c35a030812a219ed233d447ddfee6495bca Mon Sep 17 00:00:00 2001
From: Noelia <97019400+noeliaSD@users.noreply.github.com>
Date: Thu, 7 Apr 2022 22:49:44 +0200
Subject: [PATCH] feat(StatusBanner): Added component documentation (#628)

Added component documentation.

Part of #620
---
 ui/StatusQ/doc/src/images/status_banner.png   | Bin 0 -> 3517 bytes
 .../src/StatusQ/Controls/StatusBanner.qml     |  52 +++++++++++++++++-
 2 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 ui/StatusQ/doc/src/images/status_banner.png

diff --git a/ui/StatusQ/doc/src/images/status_banner.png b/ui/StatusQ/doc/src/images/status_banner.png
new file mode 100644
index 0000000000000000000000000000000000000000..d2dd119479b05aa67ec336a8d97f498f92b4179f
GIT binary patch
literal 3517
zcmcguc{r497oQo@SR0B`VXP4|V=2p+(O9x)E!z}h85)@x%otmQ6kc0}ETND}Sz;Kk
ztkoB#vP_mD(@K_5VZ15L_n`N!>-+xu{`j8jx}WFV_c_0Fe)qYr=RPOJ!OlWdXr~Ye
z1QNBfG;;!hz_Wm?4;293eVSLE0SgC6rlt;7rlxR*P^v#EhzJ6yp7$jXBrG*lA9{Ne
z2oImCs|kgMJ0&NlIT22EcHHae?05?Q7d$)f=+W0ZV6XWO-vgC7-fcV~k_KO?Lq61y
zLCq^;GhC7qPN}FVhn$4oKb#5q)5$3{D}GT9ZfA{D-3xfN1=Zy|wh_X8l!D{0LMK(>
z(E`auV%|02+AR1-KEi%^;~pGW5{`!(C~9qb7z^>6QIb!&u2@^bO#mfX#3kH1-=qb;
zenHIIN!=P(Pm47sI{HVMrz9w9COS!C7A`E&x21`srR~^(dn4+&`c*)GxAX&jn2*}5
zh)Aag&KQ~KCe`N^eN9IbT5OVB5y02#*VPdWuY=dBiqC;MsTvPRo#rszWrl#j5Q)b-
zB^E#+4EquOieBaMUXAj2yymp{_^(n9^Ln5-*`t?R2ZyqNjJgorto#oh0__E4C<vTH
z0`UV97#KT&0Rr(|I1Abgd?kQkb_Mdc7Cd`}?{68Tzh-FcY-(i%e4Twmi9`zRIF&BU
z9LoS)4U!JK(cKQ&qJ61kq_-c{hlq?I2d_aum<Ti=l8JP0cmz3!LPJMj71k}#fV{Sh
zQh=|U&`)3$+zvUwO{t+oxGqu?si|Nj1c$>hp?>~oCo}V(aA1a2I8LVrqfw~v@Ni_f
z4w4!gfYLHBFhFT)qqMaVfCYjUNuhg3ASg7&4JUv5F(cA^LrKAO5|sj9^Xu(H4WnZf
z6xIU$^K9@WMv#6*qR@VB3)moPO@q=xYNGz}4L~t#t7r#O1To0nj6?>~1H>@euZvkX
z|1ZU_fWHCVegXFx==_fSP4l0~BQ#>DDU}RFq#OM@n4jR^l|O+P)Y`^>OT<Q&*H?iw
z8wp`h{~Vc-Q0rIWAP`89Yh`A9I08I7h7a29D%17()e}#0SH^tpFhjwl=+bHSwWE-|
zeNqvs7&yNqq@w)bCP&93F~%>Ikb5O>dRXV=3RN7;!AY7NIeZRha-+2VMvlWR99trk
z?9){%GdlBE9oN%8T%XCU)|+WK!qRDwYg>Tz7GoC<yvvm2aSQX0;Zw}+4WjYU(cjR$
zeQ6*F6dnhH7z-+8Jt`=lEvVY308D|kj*DC2^^Gqx6Stax!2B@W6&9%E*ytG-Km_Kj
zLQqNTc&t((Yy;o02|7E1tlz-i9_NS7B9;~3B(B@SZXj^ShZ!Z3Yi>aCh&?dQWEy3R
z!|Z>CN%|Qd4Bd_Y5HqstEO#&n9p_x4wBZ&ypxE&x0vovd^advtC~V|XT+g|6&VUl|
zTh^(yF$+onC<#uAq^z6bu#iN?{~NgL$K7*LLZKoMXr&^dar%T|(&Fda_&JAQ+D@DF
zsc`2q^teW2<G%Uf-sUe+D{rM`P}$9GsWLW(qg$rF9deF}cwblDl4?De#A?{xrzm59
z4V$X8TM4ZmRQ$99%)b}Nv9%~y9O?%58!gB)ta^1lG?b_&MH#XfWlTk{iet6EvwHGg
zFN~C3B>q?mVFo=Qd#Ov=_vBRN8Mx~5!y>4_xh!|)JHk|j^_wD#ED`y^T-H@jukM*W
z%~5pc#nPUut^sex`CJ&KB?8I{^5ccd=?0NiMbD#9kevg&SlQhO(q1n&>9RZQFYhc>
zues3TgZdw-HfRUwZ*!$8DU9dRl|QJqPdMNa{pMjF87&9KY>w7|OTqCtfIBWyEu+Iw
z^7b~h9=8*Ttic<j(OahH$RRH%#;hs5#t5tS7VS!A`FmF5R0c;rCJb-ua`(w#Rf5Vy
z?@aCIkn};-7qC|q^W0^%Tuen*mNe~x<Jij>hvi0!^XU^}n%>18cPh)us54J<-m~r(
z-Dx~kLrL}MF3|dTZ~v+{w<z}1qA5@d`Jv<k+bZHac=7~y`Ta=>58Q*5UY3qFuM8B)
z4nCW5g1AZvPvM5o&5_&&Xt|s|FYU-PipN&&2=*p1G^RKEIu{&q(+iX7%PnI@O}uq)
zEmTw8In&R#syB(RqOD9laUvQ&c*nP5cdGs9*5~b(NLAm7$0@AUs4E87eHCk_dTk8c
z-{{7u)p{+5_tvEKU$I~Q*nj?>BsS_tsoeykL2s6Q8oL@u-&1|7myaI?wTtT$>$%ts
ztrY)M?K(e;uJj5+92iHS?90uUz7HfKhx5eM2X5jom7%dQbvvGW<{qUu^&VnOc5)Jp
zcI2~DDa}TMyV>n3$Vug`)0~SvX*2o#^#U5MwLYm$E^{7%e=J|>kUK|&eCvPT!sgIi
zvM4V&SB0N-E$!L*{6Vf*PudTCY?b}uT;JVK*`7?prAKEAJ=-urkWoWn*GB`li@he<
zTQ0c>ycUK)`H{Heo9&)}pp`;yDj)6aWrlrqNRqZbNtJor2GQwVd`b1b@Bb{;8E#b9
zQy;j|=3u^uoj+4;-y1No?<QC@k$h%MWyyoIipZ+c9~iWaGS_)<F-N_(gfTWaTxzyb
z7`u-t@tm{ZpH_6u&VD8q+Y-}|Nc8{YIO-Vw&<XSMhFG}c_PU%8xx;SgDv^@bKRRV0
zU}4w@n9o@@J`mh^ZrJ3myP&rPuMksycJk?pk4<U@0?`#TmB&u^<Paxj8pqGFiNTLQ
zK7TNJZ-{=>;K|FYQYnEa1Kpaq%QGcC*|8XdTW{}0eui0mm@r?uLt9nVUYL9I<z}mN
z8QrA(=0wO5=P<CWVq9D%B$1Vwmu+&zC_X_-c$3bIE_320<jhIy+y$*!a`NNu>^c2h
z51*>(;Zo11QtwsE`%P-Non=l#%@t2ZgTnL}lL99kd3K0`uIk7@Ta=PTc6aBZ4y|?N
z($qUNn(F`QjB>iZyeP@Irl-6+JPpq<LtI-4`rOINR;e<Y%{;U8hqE>JHluUb(=X8>
z=Uesn^5Ai}+mMqA9=F>LTM*LYwx2C}lZRFenN4O*-j|7{yE3cZlyBPFegq%ug6g@p
z|9O+eWoojj-$aAxgbFjd*>L=cmwU0aq19@b(e*8K(dmo`Gx28ucudJRiRi`r<KB_F
z#~c}qH-#B0O!P~p{pHkrFYsJ~XA|qn53cdpi*2a3d9<J26s!1tR45@=pcUy(n?2b-
z)OCk*J<}{m=be~Zf8FTfmR!>|A1Ff{2ZzT`Z|8zVP2KrnpZHsL^$QqM2C`(7x41Ta
zFXiN&bZ##`)<&5{=+z)YKZN<OAh41<*)e<;i<_8sbBL5Z+k0j{-+ES{eldjpb{Zcw
zB+DK%%$!u`c-)D6JUsbP8XH1>q!Ell5o(aNAHo<b*~RHHY;0?D80meXo#(gAVyIkS
z<5oF#z|%>NR%C#6yELM;N~5Yhljj-}^KJ3<9Otbdx=C<VH-DgrTt0uM1`3DO$K_Zm
zxtuz1IGthhYVM|#tU?@a6*4h|qzbmYRS3S@GLH^mFW%uLUbBC)_$Xg_;mf$6&hdvC
z1=3NLc1C6I(Q<_nx-n=Imeirkk<7|tBO1;+f##1~GKeE@CnRy4r<Z7Mb5m6idgA@M
zFYY?#ZJin;&1#5hmxVWbb?ofinIiLpOKnNrG(`GiSAN(H``2=1+XH1E+BT~Qr$hPW
zUw3PPo4$y@o7qB0z%UCM$78>mxNObQOU}LQJ{Hnqw4eQKDX^M>=jf0J<vJ#$LJPVl
zZbrLc7&*F^AL@EiDjXZX?>2<OUpIn=>sO`9Wj87`SP=Nb?m9`W*LHCGCMdc6V8upN
z$KikyjJutEaJ_%%pn^?CsgBd~>+J>X9H>MFra=^6YbIcy@Ns=ye0J1EA?H^D?h$?)
z;Oy6w-=*OHTex^p9>Fqv-`sM<0C4ZGw;t$Cx+1f={;s@>_C-quA{(6fPf8FXU+%H&
zUh9L_4iaEiuetP-nH9iH@PhVFW<Vpe8DSf<!R(|2ygnx3Dp2j$J1F3)F&1`~+i-dr
kC^MJgY8!0}t`EZFD-nyj?#c-0Tx;a54%(Sjn-CKI4JX6SxBvhE

literal 0
HcmV?d00001

diff --git a/ui/StatusQ/src/StatusQ/Controls/StatusBanner.qml b/ui/StatusQ/src/StatusQ/Controls/StatusBanner.qml
index 8c1f791441..169e927d08 100644
--- a/ui/StatusQ/src/StatusQ/Controls/StatusBanner.qml
+++ b/ui/StatusQ/src/StatusQ/Controls/StatusBanner.qml
@@ -3,13 +3,61 @@ import QtQuick 2.14
 import StatusQ.Core 0.1
 import StatusQ.Core.Theme 0.1
 
+/*!
+   \qmltype StatusBanner
+   \inherits Column
+   \inqmlmodule StatusQ.Controls
+   \since StatusQ.Controls 0.1
+   \brief It displays a banner with a custom text, size and type.  Inherits \l{https://doc.qt.io/qt-5/qml-qtquick-column.html}{Column}.
+
+   The \c StatusBanner displays a banner with a custom text, size and type (Info, Danger, Success or Warning).
+
+   Example of how the control looks like:
+   \image status_banner.png
+
+   Example of how to use it:
+
+   \qml
+        StatusBanner {
+            width: parent.width
+            visible: popup.userIsBlocked
+            type: StatusBanner.Type.Danger
+            statusText: qsTr("Blocked")
+        }
+   \endqml
+
+   For a list of components available see StatusQ.
+*/
 Column {
     id: statusBanner
-    width: parent.width
 
+    /*!
+       \qmlproperty string StatusBanner::statusText
+       This property holds the text the banner will display.
+    */
     property string statusText
+    /*!
+       \qmlproperty string StatusBanner::type
+       This property holds type of banner. Possible values are:
+       \qml
+        enum Type {
+            Info, // 0
+            Danger, // 1
+            Success, // 2
+            Warning // 3
+        }
+        \endqml
+    */
     property int type: StatusBanner.Type.Info
+    /*!
+       \qmlproperty string StatusBanner::textPixels
+       This property holds the pixels size of the text inside the banner.
+    */
     property int textPixels: 15
+    /*!
+       \qmlproperty string StatusBanner::statusBannerHeight
+       This property holds the height of the banner rectangle.
+    */
     property int statusBannerHeight: 38
 
     // "private" properties
@@ -27,6 +75,8 @@ Column {
         Warning // 3
     }    
 
+    width: parent.width
+
     // Component definition
     Rectangle {
         id: topDiv