From dfc3c2f9b9698706446d9fbfdce79520702ad529 Mon Sep 17 00:00:00 2001 From: Sergiy Zhovnir Date: Wed, 18 Dec 2019 11:17:42 +0200 Subject: [PATCH 1/4] Add the documentation for the CheckboxToggleNotice UI component --- .../checkbox-toggle-notice-1-result.png | Bin 0 -> 4268 bytes .../checkbox-toggle-notice-2-result.png | Bin 0 -> 4535 bytes .../components/ui-checkbox-toggle-notice.md | 68 ++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 src/common/images/ui_comps/checkbox-toggle-notice-1-result.png create mode 100644 src/common/images/ui_comps/checkbox-toggle-notice-2-result.png create mode 100644 src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md diff --git a/src/common/images/ui_comps/checkbox-toggle-notice-1-result.png b/src/common/images/ui_comps/checkbox-toggle-notice-1-result.png new file mode 100644 index 0000000000000000000000000000000000000000..ee30f72ef5c18eae7f261b04d3995f70c0bac9b5 GIT binary patch literal 4268 zcmbuCXEYlC*T<<@vudxR_9``E7Kv4A)=X5DDxs88p*5m0s#aSxcABC_h#9*!RV!i@ zv8DE^O|7TT`~7{ty#EjP-rqU*+;jf-ocrOvw=gqgq~oC@BO_xpy07<;jO-fpU!6uv z@h`e-EtQ60;_7AQsOsw^C>l>;NZ5lw*LP9`uh6Ok&%OggYoh4M-C2#hK8%FtH;O373JmW>FK#SIU5`6B_$=z zO-(O-eZt}J`1tr#BywhE28BYMo}Ln?X6Qnu8-5)|Mn;;Xk_rn7mY0``{(%`3(55h{@8V% zw=^jEwn#ksi=Gh`5=x;zIn% z6AdgB%vg1N5^JJ({$-YGPrmBpy~bm>tb4PElwdqP*AD(noPp>4P=9V&!lI7O z{r{I%=St-`-BWjF*O*t&4!h$Z38(0~M zQyl$%sqr1NbTU3}?t8Eacli~0tH{cApcD>&c{(&V-f+2V7u0llPM;XYp(uX96*_X* z$6V|L*EzXhIT{gIU8T7j2%4f-YxjAcd&a9bFRo2Mk^~yUgxt(mS+Y(c`OFfV%xApH zonO&3oBOcs3f>EkX5?207)Ajj zx==xmUuAFJ;|$X1!3w5tQParMpLc4m6d0hqC?phyTDV`iaNNIsR&QqY@@kcVNGBwe z*eccjPJJ!KV-l@~=WPVW*^zhx;u&zBv4Qx!9@mm^+ogkn8F#%e{5jsIe;3z&2yPXd zOER*s7yjIHBvL`hfv|CXvhAtQOtuP|491~ST~CaI`?sd=BuZ%)NhYBUteDiG+ zg9Biebf2y_v!g9jHJGc{Pv4SK&9`H96tBGoUv^)IusBnbTU`6f-=s#{2cty`u1)~j&ZYUv~W3|EP~v^Hnwx=G@P1@ zJ^a1sZLC)NlV=l4Lr*IEZwj}1G7(}o>7E!o*yc(Y{gDrV{_$6<8x48 zU01DqdY!;-8Sc)_kFAv&P2DDLQyLG$C!NE}( z;|ja)p8|~Cf+V0ffZQeWoB)X^x#ksW z0#a+d4NYbIGg4UO$=`%{%ve)#6KsVMu>V@0c z6u$DNwY7|IKs$oU4xJ{i%1?91!`_`eipl#m+T=xG+qRQk%p+qlV(eEKjk+ColbI!4 zjES&_uMo4-;a&P;H7wp;*ppvi_zPiMepWYpd&|S2AsCh|LDtZr$3h@h_Qw)_j&>bg zhxm7uPf$6~5eZa8u3Ft<^fw+@W(elVF|s_AOD4DTo^T#43|#~evvFx`|HwZ2{QEkw zO^pUms|$c)YPgj&Gu{ZBCk}Yqdv+p95rDw4FDr6%#M0!q)NxmaY`C{FRZ0S{he)A_ z8ef`68#)xsT=aLj>$3lZ!}=7ghsFBYE65%8l-g>dZh|F8=5mDkUOn@1Yz*VG?GLgKayVx-aNOH`KMzgJ%zm0K6I)9Ia4<|M|Bq$kAhD zcOVz8(sX>cd4sq7gylIaRL24q)1395_TTbbe|WqnwlC8h+=oKxDSDl_JJ{{(D631GFTN zmC=$9Bt7Ff#VCW#cG#89BfI+~R#ZUUO#x_U4*DSLD%g8Jzr;#q8+E%=yiPi}P;fvz z;d(%UZ(eli7t{z88$ZsS>dG00CaAN!W>~6*@`EnAz>-FUcm7+7xbm z6*fjvI_=`-IIQWfsO#w{b*bkdy}w6r>p&IdT;Xm!S!vd9{Gf2Gw0$kG z*}7&IbiU{$U2D<%Sl&@$=BB?PD2yf`k@ z`%w*UqJy;d*Q=bkd|xBO0#!6D8#Dd9X&@|k%4_D?RW{kBDXM&EZdTOvryR%8iYU5e z-1Ay`CPMrNXN_;gttiVvN8>LY zyL^qQmKwT8&4wutZ%S|}m+fo%A@?=X27}0h3#Dd%+O0}4Q}kt3Ww)Y-aN{Cw78}TW z+zfHjya9~|K&PiIE^jM<_ct_FoGpdTuh*l-go{kD7n^q8unQ>_0knGR5}vS&&c^G1K(GKR0}(A$m@0^mP(Ii8p<=pbT?8j$_&57 zgjF{!KQmIQo2=0ur?qjzYmV95ntgY!h~cqH_z&?Hn=xMbixyfjK#-bYj29jX!9cm2v95Gta4az^JjWY`@Jhy2!*6lOo5Y(JXgED!Up#%iBJ-xVkI`++%Ur-MMYAG1@ zIFp;yb0_I2VBf2}-SZH$<*97*tQs;v%ae%s1+XkxSEVOLSo_+|R^Ov1nn*p{nf4@M z>Q11>iuol){A(9~1Q5|mP`CMCEh12O(mB`2Cu9Ne%mSw6hJ5HZdWPxF-9>E$iC&07 zRhct9j44JeXG~qodOoYDR4+vU)Uv|aL{5>FidC<^t2FMP3qtE|;9lCiOzDSadWrHq zXc|GAD)-M$82Q&EXX6eRRgo@dPuaSeDH#iZiYmh{^N6FY0jNGFHiWS4uSlHgvCp2) zuQDO{awzRTSZ`qaTxHakoI|e+xw6Qu9(=b!JoWupO#B~j0zHAi%tm&9_pRHuNP#6- zb_??kAGLdj@)nb`OCXApF%{vaDXC`IXmin(R+!FL8j$x+mtbPGPVJ`lCw|Rn=Sb_! zacy6I8sh&nY-w2?5lup;i;GfCsHQ9?d_kRjFdT+8wNTl_iE5hxGOUcooJEf>gy!zl zc04*XAe8S13g953*n{U~No>Juwv|$AlLsS2_+-gM9Q@I)c8W+fQ-$ZmHMx%hzY(yG z?)bPLQMq!@D64>X?c$Y}C%AxLD`eu5ipeKm` E0F!r0>i_@% literal 0 HcmV?d00001 diff --git a/src/common/images/ui_comps/checkbox-toggle-notice-2-result.png b/src/common/images/ui_comps/checkbox-toggle-notice-2-result.png new file mode 100644 index 0000000000000000000000000000000000000000..060a4f9f30707d6d61a6c70def7d615b697c3930 GIT binary patch literal 4535 zcmb`KRag@M*T+ExlvF@R2#N}$M>82AB|VVQEg}dAj2w-0Nk|C8Au?jpIJ%K82}wtf z+~}76{O;bX_v-y!od5rv^PJ1`oaaRAKvifcStvthUu8IOl>EJ`cKYve0Q&0K&`ughXx}&4x{QO)&0tA6T zqN1XNgoJ$1f;ar8i;9Z&_V!FoP4RfVzrTNadO8Au(AL&&ZE3l@ywudxoSdAjs;sQ9 zub-Ko-rn9$NlrdKK3-W_85f9vb|qHjc(Wu4i47W*YED?3=a>7sVd}u`|9ZE zxPNlR8#$lbyYJ@W6dN1+DKSwyV_7%F7hXh&2=sCLCi^lW?jH|6%uW-}Og=k;;}--Y zupA*j*Y?iMzpbXX?bxGUL1MBrUr5=R8!`qC1z<12OaaRDTX_eUQ zRpPv5$|vm|*}$N4J12uOxlwJ)tsS$>h<1!2P{I{M;$2#`#(VK>aWP1BKI9FCxZqKG#wpxxW$8! zCp=o!7THHS7MD32WovDf$BL7dg1Zha!-3pcE@xmszTB9kKu@CAuw3>9yREENqNKn; z4MHeL;W?$Hz(nyROmLn* zcq!)>aXS?|J&OIb)#j-;I@Uta*m3!bBi>|Rtm&u9yqa$M;zpRPZEIE?#P zDL%5zl!q+qtG9G_)j?bnA^+wv5B)QNsFN+&xKXUsqzFaWz{QOklOUAU)EO z>j73I_rz?Nlt)*ly{BPY?K2hrRmmz@K=JP!ftH-040mYvn^_r+l(LW<^L5nSYN5Wc z-T7Aq5-=Z)LABb+hq)hfM%?UKfdHDtZ&ldIO;6a!>_WMYQE#t zL8{RV;F4^QXx6!z=*grATBs*(CNxV5cYlx{{imR|_0G1v&=wfbt-*j32 zzK+R2;)(xLl5GuW)j|ocS!Pr{Hj$!&PW01uX!W{&G*Wh>PL7sz5xjW_`cqvN!AonecyDVeyuyjD z&E62q_SIqJIVSov+n>A7*fgF603i)#I7;I6n~+Vgv_M(OlaSrOq^On=P*JV2v9P|1 zxo_fD?J$?RlL6O|m}KsF7*?=IQ%gaYUmLil()Zhy*YQe0L$B1u7BXroPBAom*wy_V zv=>JSV5Fa^LLJsysi;N8k$OI%0FKY~A$*KT?>@18Cj$&&KccO=)xA6w4*PXkOkhUg z{00yfyCdP}_h%(E#TaJZ+vhz8cn#{g|~?Z$b;r zuVw-si^cV&EQz@$M!CCyV@Eq+shRxuF!~t0&Jr+ek}`pWoo99Y4ajKm8?yy3lZc)c*aNtSYfs2944_o_N@Aua4aS(_kEs^dR$?%pbvaG+==W%XSqf!y~|Em#%Q_|>235JSURTS=o| zqi4absq^o z?Uhu;7Tn<`sd+%{hFN7WDV<+TTI)vwq(Wngz_8G9qZ+vs=)muO9>aTsVwwMslSM#A z=xFQU7|@?QH3KoE!^rt;9%=rZyB)FAfhwBXKG_uUvE)a_ubF9Q794ol7B(k9Y>Z83 zIbta=!*}X<$R_DcG&-Y8CQO0{Q+|ukhQO_%oV};jW)>QM zNxx#W`Pu3U?{P7uR9hu|V3=PVLyo`YT_~2D@pf_Mn~2W$Gl#s_YRsa#u&zn0l2u%TZMLq~kqpFTD{Ob%JpPkI!cd}g1>`P)LHif$8~un^$!yJ? z#t&#LXyY};=z;kUz94$qBuJQLDWCDg1b8QX=~B9U@oQ$$6gRQdhoSB91>boQ2PuDF&Z zlDO|zq)B=}LEWbY5XOE6H|!>&-uL;?2$3Jk;W*@{lUnmd5XFlhj;|gPEqy9Q6!zLe zV&n!Hbsk2rgl4V}7DRyl7e1h+XXDP-nNeto%O?wq5w*9`j=3HzRj{~*@q zFPRLsV{<4FDvN;>HB)WH8L`O9r6l0CMXlX8!^0Y7(l*QUmgbqJi~~O_=b0pRrrd*g z8FZS_Dn!d58rA~kJMn^A5YXRaIyW{0mci{8jZ@N}zi1{O9L_mKLQ!R8vKErPlJt95 zImuJwO*0z{HZBiSNQ0smyi|csOZyRN-wX~StZFT)h*XwX2S8Cty5rDTRq=L6VIi`7 zW`Y(`f}b~)GpMv4q-`1ri}7W}E?!q5Y9P^$ub8^|wAP*n?+coE@P5!KQs*WY+6&D% zcw4$Kb6xWA#F=WrRBTBJc@^}Ci=mZrI<;xiLcm-R!9`<|kIpn(wj-cQBqxJ*INx+H zmABLZJc?fH_#E4}eQP*vZgbeblXJD!?7Q2iLL()2a5Bptnc2L-2=mh?sTxPi*UBD^ z$X;$G|FB#IU0RRTq!nvmK7oE|Z0K=Y=r?+4lQvhM${-yOAmMrDilcBN-4cf9P&YWQ zPpbK)k$=I3qgk$ah!|C~c9~gH#$3N4*Jiw=i_aciP2*n}vFNhS<#Y9tXQma?_Wl|^ zLfZ1FY^@9R+L2px9$o2b++u=8!|e3i8Nq)?QSS0&$MlpzQnW+m7%}5;KP#G5ehKFK z#n&G#lksk$--S&yE08x*h}1-k`CfW%&wB1RKV?t9dSaJT>27sh9_ViDAUa4U zTrN;sa!~w+Q2i_py;t#IrtJGvj+mC8H_)d?YU(5NdRrK5&g6Uro&g>G)0@>))^0LX znX4rxdYz?KRn%TD7Ry9Hhb6DNgux6)6WDgu)8ZNOWj+m&R|9lwzmo3NM8X6tyCxP> z!txw4b}B(D-LC$dU{}=J7q5ni`lAgo4f1^6Qab}$q0{?bb~ZtFkZF9*BIB8qmPC7j zRN^xi83RltF?2-n@gmSGd)?FL@A^u*IuE= zV^3y6NEoc&72xpF2V9j~7?96#Z4B*>W}ml{gbR1%jt zJ5VR?!;xcF33m%rjg&B;-M{nwSsiE@+AD?Nm64mtMovrB_Zv!~3(^-;P<<7Pj8o#< zBPBGsH+{Az2Dhy9 z-$dFI)OQ%x4$qRmI}38L!PQU>Xr{4Om?!(Dru6Focu}aj-yPg6suhl)A}_aXaZd5e53O;#s=emdUDmNJ%!tNt`!ZTSm_3lv|Qt3@2Ql-el_d> z#1|~AjTk^ + ... +
+ ... + + + + 0 + + Notice #1 + Notice #2 + + + + + boolean + + + + + + + 0 + 1 + + toggle + + + + +
+ +``` + +#### Result + +![CheckboxToggleNotice with Selected Option #1 Component Example]({{ site.baseurl }}/common/images/ui_comps/checkbox-toggle-notice-1-result.png) +![CheckboxToggleNotice with Selected Option #2 Component Example]({{ site.baseurl }}/common/images/ui_comps/checkbox-toggle-notice-2-result.png) From e920379dc8010e6bc0fac7803a04bdf14745b4e3 Mon Sep 17 00:00:00 2001 From: Sergiy Zhovnir Date: Wed, 18 Dec 2019 11:21:18 +0200 Subject: [PATCH 2/4] Add the link for the CheckboxToggleNotice component documentation --- src/_data/toc/ui-components-guide.yml | 3 +++ .../v2.3/ui_comp_guide/components/ui-checkbox-toggle-notice.md | 1 + 2 files changed, 4 insertions(+) create mode 120000 src/guides/v2.3/ui_comp_guide/components/ui-checkbox-toggle-notice.md diff --git a/src/_data/toc/ui-components-guide.yml b/src/_data/toc/ui-components-guide.yml index 75074b4ad5d..045aeb81925 100644 --- a/src/_data/toc/ui-components-guide.yml +++ b/src/_data/toc/ui-components-guide.yml @@ -22,6 +22,9 @@ pages: - label: Checkbox component url: /ui_comp_guide/components/ui-checkbox.html + - label: CheckboxToggleNotice component + url: /ui_comp_guide/components/ui-checkbox-toggle-notice.html + - label: Checkboxset component url: /ui_comp_guide/components/ui-checkboxset.html diff --git a/src/guides/v2.3/ui_comp_guide/components/ui-checkbox-toggle-notice.md b/src/guides/v2.3/ui_comp_guide/components/ui-checkbox-toggle-notice.md new file mode 120000 index 00000000000..5699211b09a --- /dev/null +++ b/src/guides/v2.3/ui_comp_guide/components/ui-checkbox-toggle-notice.md @@ -0,0 +1 @@ +../../../v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md \ No newline at end of file From f0d490dfbafda504672f399946da43a615daed92 Mon Sep 17 00:00:00 2001 From: Sergiy Zhovnir Date: Wed, 18 Dec 2019 13:27:11 +0200 Subject: [PATCH 3/4] Update the CheckboxToggleNotice component documentation --- .../v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md b/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md index e0a89936b7b..81c228e669b 100644 --- a/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md +++ b/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md @@ -13,7 +13,7 @@ The CheckboxToggleNotice component implements the [`Checkbox`]({{ page.baseurl } | --- | --- | --- | --- | | `component` | The path to the component’s JS constructor in terms of RequireJS. | String | `Magento_Ui/js/form/element/single-checkbox-toggle-notice` | | `notices` | The array of notices that should be associated by key with selected option value. | Array | `[]` | -| `tracks`.`notice` | Flags that enable tracking for the `notice` option. | Boolean | `true` | +| `tracks`.`notice` | Flags that enable tracking for the `notice` option. By default, the `notice` option is tracked in purpose to allow updating the notice message in the template. | Boolean | `true` | ## Source files From 07fb07d3334499d5e24772a4d832fe4731f7d960 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 19 Dec 2019 09:49:43 -0600 Subject: [PATCH 4/4] Copy edits --- .../ui_comp_guide/components/ui-checkbox-toggle-notice.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md b/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md index 81c228e669b..acae0e4971e 100644 --- a/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md +++ b/src/guides/v2.2/ui_comp_guide/components/ui-checkbox-toggle-notice.md @@ -13,11 +13,11 @@ The CheckboxToggleNotice component implements the [`Checkbox`]({{ page.baseurl } | --- | --- | --- | --- | | `component` | The path to the component’s JS constructor in terms of RequireJS. | String | `Magento_Ui/js/form/element/single-checkbox-toggle-notice` | | `notices` | The array of notices that should be associated by key with selected option value. | Array | `[]` | -| `tracks`.`notice` | Flags that enable tracking for the `notice` option. By default, the `notice` option is tracked in purpose to allow updating the notice message in the template. | Boolean | `true` | +| `tracks`.`notice` | Flags that enable tracking for the `notice` option. By default, the `notice` option is tracked to allow updating the notice message in the template. | Boolean | `true` | ## Source files -Extends [`Checkbox`]({{ page.baseurl }}/ui_comp_guide/components/ui-checkbox.html) component: +Extends the [`Checkbox`]({{ page.baseurl }}/ui_comp_guide/components/ui-checkbox.html) component: - [app/code/Magento/Ui/view/base/web/js/form/element/single-checkbox-toggle-notice.js]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/view/base/web/js/form/element/single-checkbox-toggle-notice.js)