From 7ead90719736664add9fb6d126540c78bebba594 Mon Sep 17 00:00:00 2001 From: Xeevis Date: Sat, 27 Jul 2019 11:46:26 +0200 Subject: [PATCH 1/3] Add missing image --- docs/cs/images/widget-basic-files.png | Bin 0 -> 10185 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/cs/images/widget-basic-files.png diff --git a/docs/cs/images/widget-basic-files.png b/docs/cs/images/widget-basic-files.png new file mode 100644 index 0000000000000000000000000000000000000000..bf5f122d42a2b86342d85017532f268e732cf5ec GIT binary patch literal 10185 zcmaKS1yCGY*X`i$65L&b1$PewA0W7Ekl^m_5F`Y57zPRMZXr0qHMqO$KivDh_tjtZ z>UH%@^_lMJKBvzSMMEY+1^@tP@^VsY007hwlb?V1Os<4x-@7Lc-S!g$8sTlIO+6#4w}`pW4*o8Jxxwi$rMJTCNNa%j&bz z!w>Y!!ipzseU~#PB_oqp){0U{{#e8dlRYW&fPeXGf3_4VFbiNE1=|Y;>F4I?UTA$& zQ)z82b3^RhA)Jbb5H)fr73-%m6-3$|I%TgGr{{~SYg_W)LyVYnL~ggF!l&JsOhFXt z$*Rbg4G#Qt7yEnBI2g-K;h0gRpnu0x~WDQCM!+cw)b zb!YGk4Eju1jLAi!c^vVd}G(~;G=(cHX1 zNKNK&o0j$bsbQHb)+8flr0v`8im}#nSs4gpRa5tPT20NN@q;5s*hZLI_BZ5iKjpkk z^i^h>EF_zqljHr%&ukALs(k*|bb4NgxO#Yah;J9KavqmHDWa8_r^O=J6a;1ljA6m1 zThs8G;AsH!RA42FCeL=3oh|zW9TzK~?&j{>dE27u@|6AEk25l+EXF@|FHLR=t&SYJ zfH(m$2o#8%12mN2$Z{rtncEBP<+Eg9BXSje?eCQP6Xsvu3^?XY&|PomrG2gb&|XRRD*p%76Lx<9pj_Ug*`5b*1lDclGC0-Bj7#%RoB{!B zq~N+fZ~(3}?VPg~>67b1%NvPxd|MbJEL3oOseU8qPA*jlR3pvE2e)_IG=pckM1I2S zR_IK8UNn*K{|qZ$`~j(78wMnR4Bt{|D17ZN_;ROf{d1!bXIXd-=gXF#+T{$K7C|kQQOFGm+%9`o^ ziXP|eD3em5Nj)VnWprzY%{rXV%&?xJEN4aH_~4SSBYo0RWjhOrx~Xy;iP!02nYL=X4~kO@F^M#O$SXtGsql(^N3}qucO^ z!?-vlqS_6Vy_IFWmlmYAf8#jgftbs}l$99aQ_epXh#&B(cKzTkm~AI;C2S9aqD0pn zUr3ACt;d8-SM9@|9UH4`y4936&wZ`pty=k&4g+}Kxy9BsbK^$fB)JPTZgt$9X(hkz z$W-L)oh!do%j{2*NQDhAuV5o%I3}7pLPe%(XX5kR7Mg^ZB_8*C4&Z`y8D|+^fg7v! z*Zdl)p%^o8c3Ya~vB|2pw`IEl_5GtLv9tec@eorpBMauJ$#pYMJW_fQ(u-226CzXAS=1Ii{L$ce zogkrzFP=a+gzJa+I$sXLG~L#(FkQt6qL_|kWC7Pm5)mD5q?FdBbE&o2@ru}EiYF9) zkKwPPL*6~NsQ%#CA_nD9K9dWgLQG;&=NpKEEMWd_6+jS0#7J&66=Kj3Dl+qb8zZP# znj?j=6hn6$k|8{PY=i)@XK73+e2YE-O$YdS|1%943j^-p?$z>Ef4`qareT>D5Mb9W z&ZtIKc1IF|vM@7~D%0@O%BVQ=@?Sm^uhS7c)YKF?u;HiNgh7I=^JYcnf1x@}2wt~L z!;5R3@VLN%BPY{7mI!kmDWO>IyUy zfgaP3hDHQES4rJw*wa8$_?6kvvxSuwLDI3b zob@8EU4wt9i+BU*<~i6n;1Z45h6aF*Hz4vH-ZtS*8qh zycWSReu4mFU}=Sw)KR0TiU|gtFzR?GX@TtG#(U70`c|WyPTy5cE!sGQ=vMrqgD6#w z2~x_fmkU9buhd`k;wiYIkZ@)zbUSNZ4>c1CNfqS{w7#7=t=ItOKQ}sA3T-kg$vRor z{o>JqzT26X*MWet@_B{TRs@KOK zIVqEK3my`UvG|`MeS3|VvgRLw78kRMbcdq_7oO+q2?eH z^Tdb{(Cr*4^g$s*+T~Jswpk5zhe1}_Itza7TEj2Uk|m!i z-aT7+#Bj!*PS9RROj18u@od4R6j#+WaH4BSpv6T8q{uW@s;{7vBnU@2#BK6Jn1TKO z;OJ&QY-TDGj=~-hU#kI$LLqC%JXP)50FFSp6|(LC&4kYevkd&ro&wBOGn)I0UjyH%{A<@Yn%u_p71iAce>|PcZl4p8U=FBN7X? z5volX_dGE;Q%Pg^#}xpuUZ+u}EY}c)FAtT|gK z4`wUit=Nb`%T$Ueg;u#H(IUTs+5`-Z$f#GRD%B`mRG+^j3vW?Er_BEST1w7L9!sGiI zG&nHG3@c8D!2p)$8oVbf^d|Zb&Sw0JvtRGVH6ag356rC|plsaK(`;1W*zlJ6Jv5=x zaTt86X~x{PO3v$pSus1-l9CeNqNB7-z|IQ+TPesN^6%nbKeRsgCP+BI3l;cYvF?1E zu28KdKY^7~SA6+Xix?DxH2qn7ch_=xPeH)cDBvg#rFKbFuT#kPd2x`_3AryLY{gf0 z+*@s&mTP9=sRsukS|GL4ZH8l2_#OF5Ig{wK=fcmI^AkdGY@P+~!L_Ur zlzV)&8xNM z2!4Aq#Uu_v5KSL2bPw-A+&lH=xu0-rsM=@&vewx|dVEz5t zjf4MjjETvhuih<3z(q55g`S&(rfwQ>R83kWGEY2iYS3f!;rmK^_K|@SOv)Orl@K5s zkhSH`eyk$8tPv+;&1V&6`_fRCKuzyyI11b_-l~gjL%rLbem!VmE4-#9|KFuq8P{^Ht_Qx6XkSxN{M95m0UN^>n3se_&EQ( zxTPA~tAT_VZ19&kf?F0BHTy$DDbw%W&W37dZyI^*xfu<=?M=L3T{m~FQy>sIeT)4{ylk>cJ;lsk^P{% zwLfC+qJztx#CSK8HMiT}Bg^RZ@6RBZuJeX+ud3m*4V@I^pjB5)^RY5xUELT z(ry|)n*D5Jy4k>RBrJgCtmH2epJNISY^U$u=%6` z?~+UpFo6!J_Oym_am@_(+k<8po(1rAxy!FQaZRyw=0>uz_1lUd;d9rqF0UVJ!~g9d z^?Dr13ysz>%$y72(3H|FmS>;{0u{?B|5~F-`NtuCCfP02>O-*<)!q7#bCgW*b#8RZ z3jAhQm2p}=Iup(Ix9Qs@D=OTlo9)UTjqFomsLMONPgJXZ*RrfCIp+HE8SgtJ|VsTz+;ypoA4 zo6@*0wRss>YYkpB!sN*Bw(trpCcTf?Ck~2%nikhK*8&3efY$B9G5@&I6o@O0v(UGF zoFR`aw7ER+EMn#DVLNz?_c;l>=o#&3l)$`c@NhifyGf^Fs4|SKBno~f6`Rw!9j8K- zu8xe?`W^;w7N5%=F@`XQutaevzGl4NIRPi~`fkjxVdy!-`5DmDmTL4(_fiGF&V@Y4 zF{=DGrI}@(Z#C`LV7?B@h$lr);~9Tndkx?x1%Wdbu-PRX!O#T;06zGdD(P6XHdSjNQHlq`S|ZuG1>K`2pIAUcV4VU)bc`wpzNNh+I4rgE0dsh zxMr;J;e7pcSh}}xF|d9cd>p=VO&(yYE>_lffaH);1p${BGp}Pk_ob+WT4+S-g<*!o zZKL0F@9H~BFHV3^02f!5wPP>yDv%IkaA}8YW$in!aKB919W#7{Q^|cHucG&zr z-bBYgp(*PhO0F=;APgIUX%?py(>vKnhcOrK6hrF@TsV2(_{RtK`wdFOBoaQ8ENCmH z&WrOXu=e?AdhDhiZ`)mhyL7JDDg###4cfm^4!k53gj(VZ?tvtWR9sOtoIU{pkWeUd zJ>oyS9z7t`qlszRr!0KZ}elKRqD6i ze9L(%EZE%P6AYt>(95k>0uaS|K~BCtRJ{uNOmD`EK3q*JpDxz_{?hQY&F)X=J_m`Z zpm1lADA?IC06Mx$RQA3P`z0vI$Q`fG{tx@gkWWcY>>Dj8FTzhOo`3{r3jUUSbo8a& zpwo$#=LPgpmxN?@osTQagxXD*F++WGvZm>o!L;hA~ z+U9w`Mc-2#jBs1BgHoWy1>tPCKM?7ZZ`}r5`v6u zc{D}`<+WQm`WIK5dYOvK+Q2cUA!JjP^20AeXFYVnFaR-!nGbVtR1GXZ2VNRp%JDs( z107-v2;J3f(VyTYIG5{ujC2D{Ay=VlUY>&cK+yRR^)7JC^Uu$%x^Ew)+=v=>UK*;xEO^$Q z?jNh*vKS<%RyI8(*1qnrIx+*gxHdj1q&-iRev|`Hpgp?4whne`bXkjxK-Y7CK=0uv z^P!6);UrpR4B+zrB`I;mWvVOz!y2&F;jBvX#(>p^-<^^CMw@{uDg8$wjWZ8({Cuq8 zpD7R#SrffG6Vg$Y41NU-^yC=Ap`wkZXi0*iq;Vyy(;ER60eay*8S(2Tjr3W<2C;+^*Y1H0GJRqUipEA}dBL_sb z&5eTeSoD@4=vgzQ!?v0JV7A3f;x!*3?Y*`wXcbmU)1$!Z(~aV?v!w4iP(d^>5Mx9| zMMXzNWlFK;=dZnJYX+>t5fBpYA0HDE5yfd9F4Ctte_(Z8BRq2GyzF`TG3)I6Ja^Jo z-C4Y?cY9syq%@jVhPa*q!>abidJ;%w$ds_6Q^U1YDA~C^tb)w0mx9S-gu+t(hh zF*3ZW)?fofq0P(~!oy^?T;l#X78!yg4(9dcTir=4bw-Qr{V66FT-*4iBeUmIWb&LIOrd+m7fCt0mt zFGDcDj(DS*+w9UDrH>(OC=8IJMc%Q7hEEU8AmEWv9SiHAj}puOEklP8)vWO1iHy+5 z<(VEr+1=gU+1c4ACvSU4M@Lf+GC)hDY5pw!w5|Pk$iMCCcaFnDJTtjo@+hTo59ycu zpV{wqf$TblQo8voUZ-tGLAeK$sqp7$wTj<7Tv@EE=hP>cA%yDv?%2~npt*sFzZ6Qg zRdndh>+L(B%2bn$i^QWu0un$H3MXLc7(Sq;W{SfqV**KBp1iF>6Gz~__y6YYkyM}m z9}H^PVv)-tTezXsZNAOhKUt9OvBe=)Z@>|%s#yzOdA z0cXZL#svlOXvcM+t*Ff~10 zTU+bw^tRR1)=o`P`Sc)5|4=K_duqgZdbUlmHPpNQ&dXkEMh94k8qhH8=Oere zZHvIL+iB7UNxeDGYMLLy0o?PXB=4RsqvP&4W^iEazB*>|yNJrQ3kPvd;g5BH-a~Q` ztZCfbAhx!`B^Qsg?ZX+o3+N$A*D~~V{iiRG=cAxlj%Tau@wGCrvx^D~Zxr;kqcBHA zp)HOa#bi`8irkG)FGtp{918;+*QPc~vc0hZ_`-GXx1{r7a}L-;|2RZFM7+MY;u_?! z$~gRE6MH(|NB6gvpqKk6X6kq-#HmuSMDsMisXwuoo0Znld$9PEx&VL|9#2@uB>tH3 zOtWGjb?K~Pu_>RuTwH%sAR%nexv=WNjF#c?;o-_pQ&~U1mp~X%g*Lx|r>mfn6T%kZ zAV4Cry!88i0@2Lv8$M2lw3WIv1eH=y@aPI(oDd^tjh98fi$g%s+k!3lxXJ zd2ptkvq8$4(Zu(zOq1ATkW|uniz4k&4h^K= znup`cf^qiYh1upxKV_JnawqVh^ix)N7kg&ZjgfE(eCso_6p`|ap~!S0p`X$jVJSp3 zJQ_-LZ?Io!G42hUcje^ba&mUI9Q~1!o}QkaC1TqR&fNG?q?Z2e+qaCjjrl`%(ePLn z7YbnP#63u~xBP5xCRqXs0GL>Qa}q~U@vFtucRM?M9mWM8QTQs~fBG`Co?MyRHAC_v zU1jJoOQiTC9y0Hb<8`X*K<$w@|KJ2Gr;bO zbuFT^m)&wKk4`(HZI6O(_(hU*36zuA`~67T@Y{r(3Z7hAu%Cx$sCuD74q^%jmNQs@ zWR9j&tbC{|CS;E#Ke{LC*cqqqu|wn#g-!a)oK2(@jc!Eq<13BoI)?z5!|UoetMqxo z(KFdWA|?teUYcO485V^UOl+-;0~^YN520!uI_@pJydD(TedBjGX|jh~M2|amFUVGF za<`g2oi&_ySegAG0m((I^JQlumI?osCO}Nd*ll(>NG$KYeLKXMCf0ZWU9zXoj9bz@ z?;q`i@|Kt$*bvihk_>-v4}y&9-@NAh2CUIP0og39rN%!Y1Y#giWeEU42zjdo*qT}N z0Ik|PY=J?&8`!_%LpYthjnmlAv}`vSO>ymL{|RR#N*l-E1e9Wm@yRVuMb6cy2`WtFv?iiUOksP*NaQotNEKza? zN8@}NaM|RtEK@m&-QAstu@msgYeBIRPnW~1zIb*3Ca-ot&l*xp(N;0LUcOsLVi8C| zQ70u(()R;2+U>LakG}9%KOxLlfQsM%58M24a8l`fJ()%IUZ&XO8cW6=i#~kMP9Ugp z2HxK~rek)1-WYSb5fL(VZ45*dgdgc!=3=&V3KgZRKM<4iH6xn3b#^8y(+9TK{!yRm zYmDg_8wk&|-WCE!-ZcGopt$!Nc&;k|#z=+~fGvGWN_(NSLVLEvjAIpRKnLeBsLOjV z7s0l?Yllx4z3dL|YaPDVZgUQuZTCxY9m-4LVJA_suZs`nyG3jO?Uyy~TTy4j8{b>p zvRyyd%U-Bplv#HBoMY_HfWi|}M;-L&&gmr=*hft(>@PV_@csu&E>c6vE7p~o2-`dZ zA4z{zH9_bJ1|)PgN*_9*5dh$c+UjRn-5!CxXE^C8p#EUNva#RH426Q?jkUfMW^suzh7Y$6+e zi<3+Pft9&^&`j1@oW*tAXj*Vmbc{f_fWW}+z(DaLPF8wL&1~LxfHnX%HFbNtu%u+K zi9-C~x71X(g9_29*UNP96S$8NNXff*gufPN7!PlaBbJa;|z%yAn;r|s#qAX~) zPsIdSTU#T;T?sgJn%*5#6Mw|Vl9I6>7>&!wN)y~(hWcyS7AtZxh23VSwZ#rU-8W0j zyDvYWrYR29O8+nyzTmJVw@<^IK7cS=82M0Pq4aaW>saR^DGG4I+L?0c0a0`+@~tBZ z3``GnVV~llG*r5ls0N@m>W@Ti#o+pR$sM8jGPE~~dA7bH#w~>Qg7hVSWXT^3edb(6 z`IdCR@k?0{Nbn}-H@wODf9UuNyHvzrA08ec1LElI?S0N#X&l!-v2H$aYYo-al05V3 zKDl)f2oKzpF47)QV*~!&H#&fw$S9Hw zA!4ZpB3WU8uzlgS9r9-SaTe=sfgz>x#t%-0e-swZ`fU>KAo5lpAGqwA52P$863Km7 zr;$ztu8BlJwq<}I&g3ClfjTgLkc*FRetLR(W#w(3n|r6KEzSwt_TD!fWm>~BR{9C4 zWb)>lg6mk@35cb4ks+nLFPctG(0y-Rn+Uz?CRU6Eff)Fu5>_+;s*QYwzsoA@>7P@T z3hG-tav7Ltn)cd`po8)e9rfdi4R(52F!R&R)f{-$maymIuX9reo zA!E*-umJ|*XVU-hlqe~nDN!yd8t%hx2}}44(S@Ulk%w(lSahP?aIxuUjXzZk-mQh~ z0VU%??@o*jYx8F`>iQ)fUmv4Qz-tlcVbBu%PFr%^JS4nRoNd7A7iI-M6Rtou<<@Wapc# zvJMmcsqkv8&)z(M0{o}8!5}4BTw{%({onAM605~3#|_(?l^d#CE~sjB!W9`SJ5NgHp3HwVZ@6+jjK_xG;Mh7`9Qu1CMllrHsP(Q{M$mRk-RxFUidTvxQK( zfyk)=E*z3U48z02-@rkN%>T&eQA~E~ZGxZkSoMTs910yk?^7@izX#+65Goxc))T_C zGjZ<(P^gL-XH6!AwKK}j7Sk8zsXFOm+3m#OIxMjo3c;q28O6AUNe~fL2vBMII9ou9 zols}tRejVTlo;n|H^D#E5k?Gv|CY4 CGo0!G literal 0 HcmV?d00001 From a6ba76cc0db2b04486c55270745ce7e5e5418f56 Mon Sep 17 00:00:00 2001 From: Xeevis Date: Sun, 28 Jul 2019 15:15:11 +0200 Subject: [PATCH 2/3] Update Widgets.md --- docs/cs/AspNetCore/Widgets.md | 108 +++++++++++++++++++++++++++++++--- 1 file changed, 99 insertions(+), 9 deletions(-) diff --git a/docs/cs/AspNetCore/Widgets.md b/docs/cs/AspNetCore/Widgets.md index 9dfcddfa6d..7cd5914d09 100644 --- a/docs/cs/AspNetCore/Widgets.md +++ b/docs/cs/AspNetCore/Widgets.md @@ -2,16 +2,16 @@ ABP poskytuje model a infastrukturu k vytváření **znovu použitelných widgetů**. Systém widgetů je rozšíření pro [ASP.NET Core pohledové komponenty](https://docs.microsoft.com/en-us/aspnet/core/mvc/views/view-components). Widgety jsou zvláště užitečné, když chcete; -* Definovat widgety v znovu použitelných **[modulech](../Module-Development-Basics.md)**. * Mít závislosti na **skriptech & stylech** ve vašem widgetu. -* Vytvářet **[řídící panely](Dashboards.md)** za použítí widgetů. +* Vytvářet **řídící panely** za použítí widgetů. +* Definovat widgety v znovu použitelných **[modulech](../Module-Development-Basics.md)**. * Spolupráci widgetů s **[authorizačními](../Authorization.md)** a **[svazovacími](Bundling-Minification.md)** systémy. ## Základní definice widgetu ### Tvorba pohledové komponenty -Jako první krok, vytvoříme běžnou ASP.NET Core pohledovou komponentu: +Jako první krok, vytvořte běžnou ASP.NET Core pohledovou komponentu: ![widget-basic-files](../images/widget-basic-files.png) @@ -33,7 +33,9 @@ namespace DashboardDemo.Web.Pages.Components.MySimpleWidget } ```` -Dědění z `AbpViewComponent` není vyžadováno. Můžeme dědit ze standardního ASP.NET Core `ViewComponent`. `AbpViewComponent` pouze definuje pár základních a užitečných vlastnosti. +Dědění z `AbpViewComponent` není vyžadováno. Můžete dědit ze standardního ASP.NET Core `ViewComponent`. `AbpViewComponent` pouze definuje pár základních a užitečných vlastnosti. + +Můžete vložit službu a pomocí metody `Invoke` z ní získat některá data. Možná budete muset provést metodu Invoke jako asynchronní `public async Task InvokeAsync()`. Podívejte se na dokument [ASP.NET Core ViewComponents](https://docs.microsoft.com/en-us/aspnet/core/mvc/views/view-components) pro všechna další použítí. **Default.cshtml**: @@ -46,7 +48,7 @@ Dědění z `AbpViewComponent` není vyžadováno. Můžeme dědit ze standardn ### Definice widgetu -Přidáme atribut `Widget` k třídě `MySimpleWidgetViewComponent` pro označení této pohledové komponenty jako widgetu: +Přidejte atribut `Widget` k třídě `MySimpleWidgetViewComponent` pro označení této pohledové komponenty jako widgetu: ````csharp using Microsoft.AspNetCore.Mvc; @@ -68,7 +70,7 @@ namespace DashboardDemo.Web.Pages.Components.MySimpleWidget ## Vykreslení widgetu -Vykreslení widgetu je vcelku standardní. Použijeme metodu `Component.InvokeAsync` v razor pohledu/stránce jako s kteroukoliv jinou pohledovou komponentou. Příklady: +Vykreslení widgetu je vcelku standardní. Použijte metodu `Component.InvokeAsync` v razor pohledu/stránce jako s kteroukoliv jinou pohledovou komponentou. Příklady: ````xml @await Component.InvokeAsync("MySimpleWidget") @@ -77,11 +79,61 @@ Vykreslení widgetu je vcelku standardní. Použijeme metodu `Component.InvokeAs První přístup používá název widgetu, zatímco druhý používá typ pohledové komponenty. +### Widgety s argumenty + +Systém ASP.NET Core pohledových komponent umožňuje přijímat argumenty pro pohledové komponenty. Níže uvedená pohledová komponenta přijímá `startDate` a `endDate` a používá tyto argumenty k získání dat ze služby. + +````csharp +using System; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Mvc; +using Volo.Abp.AspNetCore.Mvc; +using Volo.Abp.AspNetCore.Mvc.UI.Widgets; + +namespace DashboardDemo.Web.Pages.Shared.Components.CountersWidget +{ + [Widget] + public class CountersWidgetViewComponent : AbpViewComponent + { + private readonly IDashboardAppService _dashboardAppService; + + public CountersWidgetViewComponent(IDashboardAppService dashboardAppService) + { + _dashboardAppService = dashboardAppService; + } + + public async Task InvokeAsync( + DateTime startDate, DateTime endDate) + { + var result = await _dashboardAppService.GetCountersWidgetAsync( + new CountersWidgetInputDto + { + StartDate = startDate, + EndDate = endDate + } + ); + + return View(result); + } + } +} +```` + +Nyní musíte předat anonymní objekt k předání argumentů tak jak je ukázáno níže: + +````xml +@await Component.InvokeAsync("CountersWidget", new +{ + startDate = DateTime.Now.Subtract(TimeSpan.FromDays(7)), + endDate = DateTime.Now +}) +```` + ## Název widgetu Výchozí název pohledových komponent je vypočítán na základě názvu typu pohledové komponenty. Pokud je typ pohledové komponenty `MySimpleWidgetViewComponent` potom název widgetu bude `MySimpleWidget` (odstraní se `ViewComponent` postfix). Takto ASP.NET Core vypočítává název pohledové komponenty. -Chceme-li přizpůsobit název widgetu, stačí použít standardní atribut `ViewComponent` z ASP.NET Core: +Chcete-li přizpůsobit název widgetu, stačí použít standardní atribut `ViewComponent` z ASP.NET Core: ```csharp using Microsoft.AspNetCore.Mvc; @@ -108,7 +160,7 @@ ABP bude respektovat přizpůsobený název při zpracování widgetu. ### Zobrazovaný název -Můžeme také definovat čitelný & lokalizovatelný zobrazovaný název pro widget. Tento zobrazovaný název může být využít na uživatelském rozhraní kdykoliv je to potřeba. Zobrazovaný název je nepovinný a lze ho definovat pomocí vlastností atributu `Widget`: +Můžete také definovat čitelný & lokalizovatelný zobrazovaný název pro widget. Tento zobrazovaný název může být využít na uživatelském rozhraní kdykoliv je to potřeba. Zobrazovaný název je nepovinný a lze ho definovat pomocí vlastností atributu `Widget`: ````csharp using DashboardDemo.Localization; @@ -222,6 +274,44 @@ Systém přispěvatelů balíků je velmi schopný. Pokud váš widget použív Podívejte se na dokumentaci [svazování & minifikace](Bundling-Minification.md) pro více informací o tomto systému. +## JavaScript API + +Možná bude potřeba vykreslit a obnovit widget na straně klienta. V takových případech můžete použít ABP `WidgetManager` a definovat API pro vaše widgety. + +### WidgetManager + +`WidgetManager` se používá k inicializaci a aktualizaci jednoho nebo více widgetů. Vytvořte nový `WidgetManager` jako je ukázáno níže: + +````js +$(function() { + var myWidgetManager = new abp.WidgetManager('#MyDashboardWidgetsArea'); +}) +```` + +`MyDashboardWidgetsArea` může obsahovat jeden nebo více widgetů. + +> Použíti `WidgetManager` uvnitř document.ready (jako nahoře) je dobrá praktika jelikož jeho funkce používají DOM a potřebují, aby byl DOM připraven. + +#### WidgetManager.init() + +`init` jednoduše inicializuje `WidgetManager` a volá metody `init` v souvisejících widgetech pokud je obsahují (podívejte se na sekci Widget JavaScript API section níže) + +```js +myWidgetManager.init(); +``` + +#### WidgetManager.refresh() + +`refresh` metoda obnoví všechny widgety související s tímto `WidgetManager`: + +```` +myWidgetManager.refresh(); +```` + +#### WidgetManager Options + +### Widget JavaScript API + ## Autorizace Některé widgety budou pravděpodobně muset být dostupné pouze pro ověřené nebo autorizované uživatele. V tomto případě použijte následující vlastnosti atributu `Widget`: @@ -249,7 +339,7 @@ namespace DashboardDemo.Web.Pages.Components.MySimpleWidget } ```` -## Možnosti widgetu +## WidgetOptions Jako alternativu k atributu `Widget` můžete ke konfiguraci widgetů použít `WidgetOptions`: From e71109403b3f7d8146d8b7c7a014e4d3a1dcdd21 Mon Sep 17 00:00:00 2001 From: Xeevis Date: Sun, 28 Jul 2019 17:43:33 +0200 Subject: [PATCH 3/3] Update Widgets.md #2 --- docs/cs/AspNetCore/Widgets.md | 145 +++++++++++++++++++++++++++++++++- 1 file changed, 143 insertions(+), 2 deletions(-) diff --git a/docs/cs/AspNetCore/Widgets.md b/docs/cs/AspNetCore/Widgets.md index 7cd5914d09..c885da9c62 100644 --- a/docs/cs/AspNetCore/Widgets.md +++ b/docs/cs/AspNetCore/Widgets.md @@ -274,6 +274,37 @@ Systém přispěvatelů balíků je velmi schopný. Pokud váš widget použív Podívejte se na dokumentaci [svazování & minifikace](Bundling-Minification.md) pro více informací o tomto systému. +## RefreshUrl + +Widget může navrhnout `RefreshUrl`, který se používá vždy, když je potřeba widget aktualizovat. Je-li definován, widget se při každé aktualizaci znovu vykreslí na straně serveru (viz refresh `methoda` u `WidgetManager` níže). + +````csharp +[Widget(RefreshUrl = "Widgets/Counters")] +public class CountersWidgetViewComponent : AbpViewComponent +{ + +} +```` + +Jakmile pro svůj widget definujete `RefreshUrl`, musíte poskytnout koncový bod pro jeho vykreslení a vrátit ho: + +````csharp +[Route("Widgets")] +public class CountersWidgetController : AbpController +{ + [HttpGet] + [Route("Counters")] + public IActionResult Counters(DateTime startDate, DateTime endDate) + { + return ViewComponent("CountersWidget", new {startDate, endDate}); + } +} +```` + +Trasa `Widgets/Counters` předchozímu `RefreshUrl`. + +> Widget lze obnovit dvěma způsoby: Prvním způsobem je použití `RefreshUrl`, kdy se znovu vykreslí na serveru a nahradí HTML vrácené tím ze serveru. Druhým způsobem widget získá data (obvykle JSON objekt) ze serveru a obnoví se sám u klienta (viz refresh metoda v sekci Widget JavaScript API). + ## JavaScript API Možná bude potřeba vykreslit a obnovit widget na straně klienta. V takových případech můžete použít ABP `WidgetManager` a definovat API pro vaše widgety. @@ -308,10 +339,116 @@ myWidgetManager.init(); myWidgetManager.refresh(); ```` -#### WidgetManager Options +#### WidgetManager možnosti + +WidgetManager má několik dalších možností. + +##### Filtrační formulář + +Pokud vaše widgety vyžadují parametry/filtry pak budete obvykle mít formulář pro filtrování widgetů. V takových případech můžete vytvořit formulář, který obsahuje prvky formuláře a oblast řídicího panelu s nějakými widgety uvnitř. Příklad: + +````xml +
+ ...prvky formuláře +
+ +
+ ...widgety +
+```` + +`data-widget-filter` atribut propojuje formulář s widgety. Kdykoli je formulář odeslán, všechny widgety jsou automaticky aktualizovány pomocí polí formuláře jako filtru. + +Místo atributu `data-widget-filter`, můžete použít parametr `filterForm` v konstruktoru `WidgetManager`. Příklad: + +````js +var myWidgetManager = new abp.WidgetManager({ + wrapper: '#MyDashboardWidgetsArea', + filterForm: '#MyDashboardFilterForm' +}); +```` + +##### Zpětné volání filtru + +Možná budete chtít mít lepší kontrolu nad poskytováním filtrů při inicializaci a aktualizaci widgetů. V tomto případě můžete použít volbu `filterCallback`: + +````js +var myWidgetManager = new abp.WidgetManager({ + wrapper: '#MyDashboardWidgetsArea', + filterCallback: function() { + return $('#MyDashboardFilterForm').serializeFormToObject(); + } +}); +```` + +Tento příklad ukazuje výchozí implementaci `filterCallback`. Pomocí polí můžete vrátit jakýkoli JavaScript objekt. Příklad: + +````js +filterCallback: function() { + return { + 'startDate': $('#StartDateInput').val(), + 'endDate': $('#EndDateInput').val() + }; +} +```` + +Vrácené filtry jsou předávány všem widgetům na `init` a` refresh`. ### Widget JavaScript API +Widget může definovat rozhraní API jazyka JavaScript, které je v případě potřeby vyvoláno přes `WidgetManager`. Ukázku kódu níže lze použít k definování API pro widget. + +````js +(function () { + abp.widgets.NewUserStatisticWidget = function ($wrapper) { + + var getFilters = function () { + return { + ... + }; + } + + var refresh = function (filters) { + ... + }; + + var init = function (filters) { + ... + }; + + return { + getFilters: getFilters, + init: init, + refresh: refresh + }; + }; +})(); +```` + +`NewUserStatisticWidget` je tady název widgetu. Měl by odpovídat názvu widgetu definovanému na straně serveru. Všechny funkce jsou volitelné. + +#### getFilters + +Pokud má widget vlastní interní filtry, měla by tato funkce vrátit objekt filtru. Příklad: + +````js +var getFilters = function() { + return { + frequency: $wrapper.find('.frequency-filter option:selected').val() + }; +} +```` + +Tuto metodu používá `WidgetManager` při vytváření filtrů. + +#### init + +Slouží k inicializaci widgetu kdykoli je potřeba. Má argument filtru, který lze použít při získávání dat ze serveru. Metoda `init` je použita když je volána funkce `WidgetManager.init()`. Použita je i v případě že váš widget vyžaduje úplné obnovení při aktualizaci. Viz `RefreshUrl` v možnostech widgetu. + +#### refresh + +Slouží k aktualizaci widgetu kdykoli je potřeba. Má argument filtru, který lze použít při získávání dat ze serveru. Metoda `refresh` se používá kdykoliv je volána funkce `WidgetManager.refresh()`. + ## Autorizace Některé widgety budou pravděpodobně muset být dostupné pouze pro ověřené nebo autorizované uživatele. V tomto případě použijte následující vlastnosti atributu `Widget`: @@ -361,4 +498,8 @@ Configure(options => }); ```` -> Tip: `WidgetOptions` lze také použít k získání existujícího widgetu a ke změně jeho konfigurace. To je obzvláště užitečné, pokud chcete změnit konfiguraci widgetu uvnitř modulu používaného vaší aplikací. Použíjte `options.Widgets.Find` k získání existujícího `WidgetDefinition`. \ No newline at end of file +> Tip: `WidgetOptions` lze také použít k získání existujícího widgetu a ke změně jeho konfigurace. To je obzvláště užitečné, pokud chcete změnit konfiguraci widgetu uvnitř modulu používaného vaší aplikací. Použíjte `options.Widgets.Find` k získání existujícího `WidgetDefinition`. + +## Podívejte se také na + +* [Příklad projektu (zdrojový kód)](https://github.com/abpframework/abp/tree/dev/samples/DashboardDemo). \ No newline at end of file