From 037a215a7881286b3e0bfc2dca0e643af2f2f49f Mon Sep 17 00:00:00 2001 From: Takahito Yamatoya Date: Thu, 22 Oct 2020 15:53:20 +0900 Subject: [PATCH] Add documentation for rule --- docs/input/assets/images/rule.png | Bin 0 -> 5788 bytes docs/input/widgets/rule.md | 71 ++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 docs/input/assets/images/rule.png create mode 100644 docs/input/widgets/rule.md diff --git a/docs/input/assets/images/rule.png b/docs/input/assets/images/rule.png new file mode 100644 index 0000000000000000000000000000000000000000..85bfa712f6cf1b434a5dd09606532f82335b9fb5 GIT binary patch literal 5788 zcmeHLXIN9|w%+I{qmE=^1End<4AMbBI?(|{2Lb6Fga8rgHPl4LQ6tp?B20u4RFIMw zs?>n=8tFv>BS;S*gdRffw>|g#xpU^+x%Zs=@8)^(WM}Q~Tl-t>eb?IeuNmqcK6vUN z1VM+dT-Gsxpgma-#C7`X{Xla6?eG@(IpBNQIsk%r>ftX}k|Ym55ON1zG0^4ybny6I zb-s&>cMxAhx>kV~g92~(_(QKr?U#Y*n?NAaaScHGyZZ*Z`*=e~51bJN@`JEk+s8N5 z-yL%!5XwWes{tv`7pcFi6TI|vpu3kVq_lxJ0PY-s@0j|y1!A52T_Jm44!r!(7v=5& zXiq1w)E_FXDM|q1uVJyJlfSpSHwLQVpSlNR+<)62!o>u-&Z03U25(Le9c?zhu;(yZZllyQ?T&E}fR_F9boc+WGnUy7crfL6aX(>LH9L z%R|tFrFdta?U(5OH(BwAqxKw_d!3aQeO%Hac1;n2F6k2EYf_awGBPtod4x3hxDi6J zFZGk%mih(;k~Q{N=2<6)OR;Iw9+ow@mOb?l*GTG~{5n|q=rYHwF}_YrO$0lst7>+9<`e0&mu z=KEb)Hl^Nl)uxK~*bov0f@EAwNW_w&qI%edo>vAGu;wkZQyty%=zDm-w6wIbqoZ)? zh`)YGWKd90u)VvZqoe1@TX_qzgP?7xcbse66J2d>?Fe9ad&v@mA&8%M%s>T(_K(6b(1%#c#7&70WL<(yh1?vJL{W)E)nb zS$)T70-@MrpmD0>*Fs3rPS583`}f}-K71I7r1*?g55Dz7GX^Q5!Hhv9b~F@Ik`QA) zXjyA&q{T8OL3<7ti63h2?CiX8^QM}|hn1BTtGB*R ztE;Ozz|BAxy7}g!@0gQQ-eLapE@-czg74G97t4^sMidSkf_N?R`nR!HTa$W*hlgQ% zZ*wDfLL^avX4xwu5BJ_V)JXN-|ZTxVRXJ9QtW0a)WN!%b$NRxAsn7 zAA#>k17>baXXet2e5aT$%3f?kzH+D#^g!m{jx`0iTM6l9=tCl)EgR7}XP?G_E$QJd;N^sxCd1 zC8pxHXS2|gtw~*@qe3*z4LbqNFhx@NT+U#DYg@LFrVqVb39cG1FR!6i4Dc{v>8h;G z2)HRCGF~UV>)W1=LWSoS76vpE;{{ZYfbyVt)64nz_z1ASt0O{nbfoOd72P_CDPHPc z!$pisBsj>8ar|iDN{Z)D!OYT90tlCAg+qN#+0gkge9U4)h}fXJ6=h~z;4Y5-2s2q4YsEvr|OC}}*9Tzp~%LhMtk`1C+` z_an_CIpyVQ-XKsap(`#sGkT~~6DeE}q3250>(}DyYxqyi4+o1qEF(CqF>3a&We^l? zKr}p;$<7ByRHh=!4}08x<)GFcX2X=ZV;5&(&4wSM--m~hMq z>FAP@l8i;(TU`|YgWtJ-e0OL0w(!nrxa>A(jqs<8w6cI>Go;~jfI4s>O0F=QDgArR$Pyhq6SbD@c zhp^d~A+s-&$6*kyyN5`)k+-|M8^T^25KV4tnC;2REGapk7P&qY!dfWJ1jQ5<9**Yh zvPDywIp(<{V9oa0{6qqN2OYsc3&&U&x;5;wSrZ8SX5GszeTXm0WYy`4r6Fg6YOe$l z7lack18O%UB_%~goPieJ5fV^Y;xm?(uU1lA+@LgIcNE|aC3s=jv!YFwsj)jNj$=<_rD+dZhH@VRvY}wvnj$78- zW9i3%Mn4ebCiq&J9%vf;xZ4-q2ePs}l1B#k*&3#jLd}(CY6W6?5*&(4~YdkDry5 zO(0;&RH;1g6GD_#xY~q5KRsj=f*SplP44joaVra$ZUm1l(9>T4Ro@&TqiFH*%eJGGD-GZ!CzY2~m2Pkukn{`F#5{vkQzzb70Pu zGX(6Q>GRb;9jyKgqW(UDxn>TjfOh>RXxINX^IUzMovotT{}_U9eJu%(Iy(P`QRiQr zl>VpNTQ8M6X{F0fYCsU*JsVrwm~zw?Q_%I2S;z)iGz2x0O^DW||I49H?miuKZ+^@U z<%BiG#(Ed6^~5i@ev1Ojn(|9WPu;$Kn-adUXpG;D;uazh2qKp z{ldF?Ys%`)^^5Dw(W>x?QYw34UnvJ0UzNDBweyCV-VA2VtEaajaLqKJ%WvlWbI@z) zuWoE0Ldg{s>Hwesf|FkaIj7070@ts@e?GZgEl7%76W?1!hK zdhy?=eqRa73l!WCZDTat2OyLfYYQmEJWD0#<;6}-O=Xiv@wK(J0A~ocK2=H%c=lSM zp)&Y1fvg5F0R|KbpqzmCfT^6t8%DP2p~JZA*H7~ZYejVS{r>UT{NSNvMPODsbC4#m zH0(i+105mU7%GoN1T_1ld*rnk68F@62Y@OKE>!}PeD1umvYxA}>keSS=%ZqWI-u>e z3m$UCcv%uiU<`ikfF=H^PD21P|q@$;iQiK-Or(kT3781;#&0pkm$W1S_c0eSeH z31L5a&_LW=$PXEh8fQm1YR0Yfy)`cim>hfgj0HeWjffg6i-Yb!7iY4YcS z*_eMG+6kAq-`(lY)O(U&#~-kQ=CFx zb){KQt(26M{Mw{Tb%4Wlbgn*AQxXxm3E)iaUYAg~6CT}q4vEnCe1WJIH1|l?McmB7qH(+-2JP!BHyXk0AcSCb zLx3K%M&U;YZ{-8zs%rJ~Bq%i+ixo0=+&o0t8l(eYG1 zGn;vGL45P)cS`ACPVJC6e8baI!2j_;cv6zR-S{!)V1h782y`aXRmA6JW6TgSL$2$4 z=0SfjRETK;u}o{21(`arS9tS6Nk{K%)55XDB2c+1zQ11((27u*o11e6r!*w0JhWF1 zlZP7vkQ2)w_0(*)G?=e``*=)*^#+dDSa)O-w}A50~mLa_3l04S@A_+R;Lv8&GZOz+ dj*I2&l?e2b5bXA=0xw~qE4qd{q#v*U{2xf=o}K^z literal 0 HcmV?d00001 diff --git a/docs/input/widgets/rule.md b/docs/input/widgets/rule.md new file mode 100644 index 0000000..2173c49 --- /dev/null +++ b/docs/input/widgets/rule.md @@ -0,0 +1,71 @@ +Title: Rule +Order: 5 +RedirectFrom: rule +--- + +The `Rule` class is used to render a horizontal rule (line) to the terminal. + +![Rule](../assets/images/rule.png) + +# Usage + +To render a rule without a title: + +```csharp +var rule = new Rule(); +AnsiConsole.Render(rule); +``` + +## Title + +You can set the rule title markup text. + +```csharp +var rule = new Rule("[red]Hello[/]"); +AnsiConsole.Render(rule); + +// output +───────────────────────────────── Hello ───────────────────────────────── +``` + +### Title alignment + +You can set the rule's title alignment. + +```csharp +var rule = new Rule("[red]Hello[/]"); +rule.Alignment = Justify.Left; +AnsiConsole.Render(rule); + +//output +── Hello ──────────────────────────────────────────────────────────────── +``` + +You can also specify it with a method + +```csharp +var rule = new Rule("[red]Hello[/]"); +rule.LeftAligned(); +AnsiConsole.Render(rule); + +//output +── Hello ──────────────────────────────────────────────────────────────── +``` + + +## Style + +You can set the rule style. + +```csharp +var rule = new Rule("[red]Hello[/]"); +rule.Style = Style.Parse("red dim"); +AnsiConsole.Render(rule); +``` +You can also specify it with a method + +```csharp +var rule = new Rule("[red]Hello[/]"); +rule.SetStyle("red dim"); +AnsiConsole.Render(rule); +```