From 2d6861e96f6b35a80a8903f44cad46965901f80d Mon Sep 17 00:00:00 2001 From: Martin Bergljung Date: Fri, 17 Nov 2017 20:52:07 +0000 Subject: [PATCH] [ADF-1586] PeopleListComponent documentation (#2647) --- docs/docassets/images/adf-people-list.png | Bin 0 -> 12130 bytes docs/people-list.component.md | 80 ++++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 docs/docassets/images/adf-people-list.png create mode 100644 docs/people-list.component.md diff --git a/docs/docassets/images/adf-people-list.png b/docs/docassets/images/adf-people-list.png new file mode 100644 index 0000000000000000000000000000000000000000..2f671d88cde9dbf5fe191f0c647fc434225568f4 GIT binary patch literal 12130 zcmeI2Wmr|u+wbWv>5ffzcS?7&-5}jacb9a7v~(lgASII00wN)xl%#a$S?JII^E>Bx zb*}5Yd(M8buQh9W);;&k_cIfvt}2I)LW}|h1%<94FRcj$1%n4X#~~pA|4^!t-cV2| zR5nsl>Iza)lymNs@4P*CzwscDGnxC{8BU^~ z%)Pq5y$<9J083-zKz+hll?G#TL$4Z!=46mMa6xepnOrxSPY~}>vV4*umY#QrEBY$v z6xTN=_^>D3z0!hY1sz1sO}NAW6$vk&n>G?Fxr?PnRn=!XQ1^^nZvHjVxG}WE8)*nN zmB}8lFjW=yL#vR+V>!`-l?np&u9~6I=nI_sMo-rw@7CGip7}v)4NLG*$BAqSA;cI? z1OdmGxDyW57`aLUD>Q@w3lBTQoKi-fY&v8+5#Aj0{qq%dEL;Sc=XMP6i_pJ5ITY)?qwJWtO zrIP!-oe_j9+oEX4qyt8{@G=ju}8PORXP-(A#10;dhX|3=$2uAM`MZsMDI4A;q8% z*BZ)P7jZ(<=VBx9#Pvk+gy)aV8tfWMKH~Bc?SvI0oE)@TS2{w!8oe^PLkkG&kyEG1 zz!pJb>E)B8TBRvSc1q_^fl!^`q(=ReHZo;#=C4ngm+q7$rSGOql6RrOc|*V$o+86U zn?tossq#iF5&qLF^Or72f?=I``bq~NaheY$>I{mw%!(YenGJcGYC8oYC7oLZC)URT zr*&Rj-Xq?6-r?Sc$JkzY-qqf%N0vuvN4Z;Fqr#JNKeW~wH_eWItub%y{UBL?xlwkq zcj9|Qe?)M^fAoDL53dKA0eK#^4$cKm73mB~SwlnHyMi@UVOdI4p-VOgzaNDORS0zu zuYoUTeNVrW59rUV{g%r zEA+m3^=9SGH(E9M3ney11tmd6=i+$9bNO*4RHc^+Ly81SMrpap1tXA8{hx40^^?4x z;}q)7tl5+_87{uADy~Yli?&PM5898;ZphBlZ_#gD!tpK?F%Z-2hIGFSc>Y}Wqk&0; zWKl1*%xjPVr`~a-Y2I4Hn+DCGX~Pn}5?u=o3#(1EP1#Lnyy)l>#X`mA5r3U3CIep8 z^Nihm;wsB>{AzHG#|ttrzh;7lc&S)%@D#_Cv8}dktj!zVYF;f~5?=b|(B`G4hUUd4 zLmOsmL|ck42Qv?aX5~1wu9{o*H9<8o4lNF42PC4rqNRrKSN#2>yF&s>13DgTVckQJ zLe>#5(cXn0g!`g*po^0bkvPY_jr|#m7uy%h96PlA+D#2G=y2r0{z00Vjly9>E$SKb z8Q0PeZ*ATVWb$T=JE*T<)vs=ZGr9`8hI^-8hr*A8#@2jekd<_m!Y!INxtYD0({$oy zW1B17tIiqsUhoO=>1W|*S-jNxmeXS3!5}QxA<_Zu3+*d@%XM3Z;ew%o5r=^qA0GdW ztRtI4wMG>&XE3`YJ9FZE0+nr$P1wN4V7NxC#-e6&>B~}^L(V~6N6anN<#Ajz$pXnY zk)VjiA*uxW+>zX%}Yl8?g(mW2NK0i>-6a zvbmgLi1p5^FIGt_70W+&AGgRSJ@2QHiQu)gqyWh+B zDcz+h6?7KFem*tHs0*qKuTw+Al;t(!ToUXA`32jIiuC#oH<;oz{sfItM}sUu7lSA`^DFdDH?$On;2Jxqnm2ofQFe4pRd+0-H-Rj`yo%dI&r(e#r zVmN;he4ia9J=5P8g{uF;K?OUdN${PhF4i^jWm$Q#Uouzbt0cYL8?kZmUw%S?Lc(2v zS&J?H-z>RExdP_nS0wR`5i=B#7(KIs+_B@QKlqKDj=f>6}jyRIhk14EJZZsKjhS5rM_!{d&=f(XYn z!W3zAD0 z#mil)UR8rD*aU+`lYG{$6&{oQ#Xkp@*FLKquD#YDt;s1rt=X&Quc>uRv}3RfCD9_@ zQVq){7P0qi?^0-dSE1V`_=qNu?DBJ9p{}uLOMlWmuPo28J>RRKFl_P797?l;t$}rn zLzXq>D~esGo$UjjJ-cg-y`jaJ27*y`WCNy7<<4wZ?{me$)B!ftxx3l&O0DIB4dyF-QGQ8=uB?{Cn^>`=W2v_u==fo@j?nXoToZE4*_YrcDS2l|??fBIbheLJK+u|5j13b7G$ouWG+<;Hr``Ky4X z$RYCg&gfi_I}TmcZ>SSj#sN~XmB;VJNFRQ6SgzAG*{_}vJ%}@?QeBd<2&VgyrbDW zJ>s(BTYu?Ju}yI!hTxa2t8g27t9_$;?z%-V$G%>PTv|Q~6=fkaM|(CCb4ODPHZOapr_Cgkh?fxXXm8(g{zs1jgy;=qXXqrxhAHL?rx$W&{IYK`Tc39g_q5L)#Tv%Pq%;$vOmSJbFy); z|EFvqtH{$^A$1!s3pVk9{?(yBqxJhOFkE6NBJBSedNGuZYYu%VC~7SQ>F3&B(7$rv6KP}?!(Gz{?1{3a z@VA`idJNb%*chZ3cz(tk(4qh%YTKBhJBJ9`z@ z%&n;z85{BA5Gx|X(^yL;S9XjRwmVt|wua7;vG zZhd{0*ziN@!?=_v8HOI5hGGRet#=sd1ja;go0U+9_1W|0Ampro$%WG?o4_ zd+=Oi>VQ>%IQ0Wgw^NaZtF8{Re7-7-n#i#<#IfsqEoR*V1J(y&w_@5FFeLZ6!x=Sk zbRYr@ary|~mthvK%S+~L2wDExWG#2@cW)}rWZi1{Z6z6ad0 ziky9xGFkE7viEsdUS3`eMkGg46T3Di^xd!TgP6tPr5SiE)b+rip1nKtyIl5Mz23^h zL}l-E%6IfTo041oh)99PJt^Wk#;n$*@?%&-$pa>|}rCK{^->V4@?j~Aono&i~a%i`iH&0eUsg2`X zWMF9=<64d5U$Gu!)niM*6uY9ds~^B$ZJsl%)a9f5Y~Q-f7v23f$yNFaXjk8g@8R;< zU2W&d2!qHoJm#u8Nr?NbPG42y1o6c;#}9R9(@GJZE8b-X(;)NJ^ZU#1h$9{2eBVN0 zF$D6}yubK!Q!4^9avK(!Zezc&4O8JI({8?H8p2+`ztXq+q>BQ;oL3PX4{3mlATuu>ppzi9csg zAWNj)8%f85q^+*j6(xnZ{c}cvWbxt;R~$p6uAyQ0dJOt*Q!-S0s@FSZdA+QyOW0ra zY^w<)6yUgpR^QszAoDM~X|?@o`PQqc#ENIY)L)JF#yeX9qqQf~Dwl|3YRU7vKPO|z z4&Dp>XNPj{F~skVjs^&fa4mc%MK42BUl+0o2bNf6pCciPJF96ThPdsYC9hyJ|FD63h(R<^4u?yE3qa=_u< zs|H;^OGjjn|0amb&YT6op(6w*V z^((9bGbt{apmG`TFG6qoGv(!De9RlJ4g()a21y({eH_2BA7>O#h+Zz$-RxFI4AbXz z(mA5I@7E8>Hj3N#&Epz2`IfV zM)YjyjT1u5fMw8Xe4_Mt#(kCq*sxd&^n>~hy+~BvRS!`mlJd?WBAJ`I4qpjA!IH3T zRlTg+`qbA*``rZfAd<^obm@g3jrSMdDcW_~L9vZHP<73lOTd*HPae!>v2po-(juUj?HU7Y^P^5{sSV|uv!@CXm~MhmFoK~`1|y#4mQ z7yQy*ryNS`^!jHOdw}KU<+Kv}z(;YN9@IN*VrPlXIFv z{486r!u3Y7TKp~Q8X!y|X!F)eh;mS+7oR-bz~@fV`BYz!lpFSwsEYTxoCgg;;8D_X zZ>f=_!qK9VX>Y|!bA5J?)?(OYW02<#x^EBKC_)2*oQx?ja2TPfB)yR#;>Iou7U=_b z<*@f*0&OaqJ<&20oxorf_Pn)7(?z*uVmJk?nqZy!)mNjy`?f`TR#RAJjLmSWd*9lw zi)f321ZA#an&XEv-Ya9;dE*fDHTzXeb{34;n;(FG$&4oYzLV$Yh{b4EXORs2@pS^u zw>~#gd=c9u%vh@b)L$WZ785KyGI@z?()U1pRp;HRd;50!-VfL&-N-_rI_udr&f8kq z4#?x+RbdcSH9iD@-QkwV;qJacU^OM=J0Blz!;piP?}rg5@?&jbN9BxQVChNZh9f>E zry65(ZuE_KUMyH8sKpKW?a0Y{vMgI8Y{c=v8VI4auvXJ%PqtgFoo zh~6X=idx+YT=!120S3WYR-f)2u9I1D%WGZU2}XAC@=}ODVI<$dH86psHIhzB?wyQE z@I=1CvOE*9cwK@p6`dL?@z|4{5VLi&SDTQ`4rX8x)YXvI*Jp*yXc}#hZdy&#IpyB2 z`Sgq@>vOA#o@?V`w3%RWN9F^bP(*bNDaNKOhcB9NBx^II(lS*C9JN+LoaJ>Y{-Ex8 zMQt~YBOHma6!Zo01p+=YoD51N&mvE1y3jaBAKEdOf6k#fw#h~?A%IL_iqfF)k2hR4 z+YE9a%B8ERG(J{DCQ-A8N&GOOFmgYk}+QiZQ|C`%U<3twB= zKO;jkRVIZ4rv;7HR5j=fN5=yhR2_%A#UfTp zl%l>O)6wK6eU@sRTm(|kX;{frT{SP*RBbKu~;F?O6SoVxfYHa_-`!Kq|n z)k#c&cTQhbR^!9NFgsruCDNOQqqlCvR9NM~f-=4~N~i4h0m;?sEpK+eHcSzM>WN3YV*7&y~cV z%)Srs>!i2*-|6+)_j7uBFOK>!>~)uDw~Hk(=nC2PIi>;eZ8*=j;qI z0c(xPxEA)oA{XCSLW<|^dNME`mYw7x1MSF`8>%s|fIr!`L7BtbB4H0&*^h6uzTJYF ztk(Zxfga=RjvP9f4JI-;L$)vHqx2wLPte$)G`KT{wFQzbUyg}`7~ssu(c<%|uLGRZ zVBZ55wUDh7xE6VsFxkYKg{vh$=es^Ok~N%g#!<>Tzb=tQy9b5OQH7K7uplzJg1%Pw z9zR%Kw+{S6Qo*D!iZ1%PVGAlLME>L3AerLYTZD|ynVsHm;FJhnXOx9sv0~79+@O(Y zJi~{yY_HelJFcG;^hh z#YoUqk11D^6*WDWECkp^k;D1jtS5N%=8Y*v>EH(IfI2=CB`%16glaqg`ZD72ZcF@F z$kL9^nGOR%bnK%IHWkd47pHOKtr*!*zi41&Ru%bU&(D~w3f*lFv*?iXP z+t4;7`9)EC7IRqYWG3bfAAxo5;zt@KSjkY8j$)PI?}cs0gCs>IuN4GItof^8ZTjfu zwvCjRn%IMFk(6@13ec4f%r7{V-RA(LOAslv(! z+rv=l&bdcqK2$`YAK)J-1z}zef6YVBi^N&XzHw$X*vj3xg}hT~^jk;20|Y`7T(CJ2 z8(D;2p_4y@v{pcAmJV?xzdl?^4SE3i+f+~uGB~dqi^I0@jm2y8&8!@V=5;xag{tt) z%r)3&s4RXn0{Lw!bAh<``iG&l9_iF2IbE@4fwD8CESlYhoyMWNBRpR;Yvxc|aMTKn zb5#0CsKUFTU##{er(cp9*4~;FP9VTZ+`#MJXnIKGKj?4iyWo^G0XsCW9Wo`<`_%Sy z6xb@<6zJzemdZ~b)DUj*dvjNO-^1?g*9jLjtjIMbMMTXMbfc>f$`9_9BAds?^3D+nSQXoR^agzhQvHH=LgP zB>$TtgMd55OSx~JqRfAa!?s3;NtKq7N=RvuZDtAkE7q$eBs8W_s*Q=BFab~|*;5!g z&KmEZ@c)nhza1ZA^=ctEPtUpNHTOR>24EamucD)CYS=gx{^2#0!62B_Sd4b@Xsqk! ze-Te7z)ie|GgbeFK>#-akp}$cKft%4WCys3p-XAdls%K-iFg;sM_*YZiPH9%S3g1HU(V}%x zTrbxs3(ktydYqwV^X1OJVF}45-t|9#giOYQ8`X6)^+h;s8Uz#_jR%HMRkiO{n0(c> zLcjghY6S7wDd`hF?9{sah1GR*0{{ou&1C>;^g<(&el8Q)?aqAm1R~FZp>SM0G?pTY zS@GP}xs^iPO|zW`8ArK@qLzb?nF`kySP)u)2|%ytOH1WRk6JDBGi{(0+95nr<#6 zIro!yt|#vyK$YMF1j?q)ubX#exx{RMI)@Aa1HtA8e7Duh?|}*6uvD-fW6RFZEJt#O zuJf-P4_E6}jxQNrTy#Tt>2lnr2@}i?{AYDu$m}Wdac(v4Xc9#wi%xF6nroO-nwf1M zJhv!M5jeO3st8hSRvf^}v{-J1_Ns8c z8v6bUs`FV5Bbc_YUaz16*5XdJhppsaJ(%&cqqvN36wo~>c8VMhZLG<_fqIe;u zCGV{qlj`QL(b>-m&Vm8j#8oN?%+o@3W}1^HNaqPNme3~R<-9auQXGYXFbiNx+8WR# z00ab*a$H6jSNn0)Vk?F37W`z@ji>3@K-AZ72)|?sK(2G$zv@msj?+xP&=P+*ks&bP zQN^!v$yCM=+Rk_Ce?ny^R_rCVSgV5JxSHL;A5OSHzn&K zg~F-`3^L*ma7Zx#5NpM1CAK<<$fpv;0kP9v7A1(a*PY1Ca~`XRU2m)cn{u?)?*YEq zcQy%6itd7_$`mjU)1?=^akiWcxHVfre!9(*eBbP*MuI;BUJkXl<(mVEB`|y1JoJ^FY3LZmAJnm=)a(CnRwgdRI%+T+6V17lvNI6>$iIOzqQzj+y z8T}1r0e%SKyDdy`RdvfE(^n!+j!~9I+zTD`pPOkf*)BAsRUG}XVxYmX0Pto`3ljq< zMzXXjfH5fNGkTEQ5LUwm3iK#|C56}Q?kwU#@CnNe=b_g{LeCr9dja!^n!jHF2K6}B zxE~ZbFArT1KO29Dm6rDf@oGZ!X1fS}&m{WriPC<6tDA3xqB2f({6jI?s31AV(mep; zq(GD$+fh~@u8j%IN(BYGYN-lZcs<@{Hm z4eeq-8}S>-MegA9AAOkOvA2|UUyK)r6eY{kp`CZMA{oKgjOqb&_ApzO=g*foB8mD{ z8?q@`N^?9G8Qd5g(=fp;I$&Me==4{1nz~+P2YwV-d{N@|9;2+S(%?3(uLhpWh5pI_ zzhLpVDxX2)9>Z!Zsin?;gA~GV`WaZQV)bAk_Q|8E>*n`@URM$u2b04Z{cXTghF_)Emk)#3cpDKNy2k zZY1QkSo40z^SptII|IaouWO!EI1TE>Lf4lXvyj5ZS#W))n!VnUa-S_aQF;skyrmIL z?1vmIVr)DJImb8{8&6IA-VGOOp^S|jIOnMtgJhQU7)Ly&)AMUe^c$Pjz~wdBm?|F& zM)-!|(SMCXrqAXe=dPn~^wmo`$z~1i1ojp`1cr}^UZ7`*a(1=4eCiW^Ng-f7U|cJO zZGXoG2jYn0@ajeM;21DX1b@wwz zs0@=n*6YIE1zV|XTw;sF6NN)Sb>rhnkLUUx5b>X{)tCjse1#p$_(Cy?X&U7;XW%)| zh1Zt#gfM;r2;=7V@PoKr=kZ{@0Tz6l;ktf)M%#BRWz#G_XgNYCX9&icKwiG9iHfXd})c zL>#WC{RkgIdh+!c6VoU#P25L+N*dnoH>#0tA7`D0fRHE=Oo_2P5palbpkTR#w{(x$ zTINkP#?&e3Fz(ju80^mzBRpGFGv<%?>gzF;(3A0Sh#a0>aXdHWlQXA@zk0YD>ki)+ zOLqhCPgQ5;ojj)5;%iZiCfx=MV`wu+s7=#T780u{ZUE0q|3w=G8VHOOE192xDU*>M z_;9TO=|TMn9AP8x6BXo51->J>f78B(@exm>8q>v*Z{$sy*!cfJFs3m65RBdx+$tdi zV2>k;RF~hk`H^|A&>>-(AiaS~3I1V&=Q@$KQqAuK?Nde-kuBT4xXFMI%*5Bem?m$k<1xTzk)FXrE787K$y&?zuPGp>dFgiOpxG+yX~ zpJ2OLbG>FAKl~-KeQ1!hTX9^NU7>}hMVLOORkz4lp1F-g^2mZj zhY6WH3Ez8g%ySQM%;Wbj(h&U`3cwWRebfm%niw$d67p0P^$x2SO82pcF!vSYd~Gkc zZ{e<-^6c&xj-muI18#QKJ)>=Rgf5E>keal1JXuEhWls_SUyKb$Xog&}uC9bzgBfN$ zGU?W+*!MapCJ36B$I?#d#=98Ys*bV>lA)44d2a2q4yx4O735hw;UR@ml}KytP_l)_f+Qz zb~pQ+=cWnJ_5)&QRoGo&vP3CAUshv+pr+Rc&r0@#B<|l&yx*Wx^qws?$QiVyh5KQ&9 z?60c*^c?CE@q^lPV*uTk% zf!hw&p}98yT+F~`09uQy?)4ADNtB=lii`WqUH!K=@IY%}P%!@vk98Ngj98T>Oq(8zGCcpfl+JMdOAzqF*Vva*tqpX)cJdg``NjKn*BDJ2=J v=Gx|@KTV6}0$Q#SzC!ZP9TuUOo=0c}ywARhH#-eax1AJZRHbVqjbHySnPr^M literal 0 HcmV?d00001 diff --git a/docs/people-list.component.md b/docs/people-list.component.md new file mode 100644 index 0000000000..dd28c66e25 --- /dev/null +++ b/docs/people-list.component.md @@ -0,0 +1,80 @@ +# People list component + +Shows a list of users (people). + +![ADF People List](docassets/images/adf-people-list.png) + +## Basic Usage + +Populate the users in the component class: + +```ts +import { UserProcessModel } from 'ng2-alfresco-core'; + +export class SomeComponent implements OnInit { + + people: UserProcessModel[] = [ + { + id: 1, + email: 'john.doe@alfresco.com', + firstName: 'John', + lastName: 'Doe' + }, + { + id: 2, + email: 'jane.doe@alfresco.com', + firstName: 'Jane', + lastName: 'Doe' + } + ]; + + onClickPeopleRow(user: UserProcessModel) { + console.log('Clicked row: ', user); + } + + onClickPeopleAction($event: Event) { + console.log('Clicked action: ', $event); + } +``` + +In the component template use the people list component: + +```html + + + + + {{entry.row.obj.firstName + ' ' + entry.row.obj.lastName}} + + + + +
{{ entry.row.obj.email }}
+
+
+
+
+``` +Note that the people list component is based on the ` + + \ No newline at end of file