From 2b08c2e06556e8037dfe9e78da35ecae64519ebe Mon Sep 17 00:00:00 2001 From: Tushar Chitnavis Date: Fri, 7 Jun 2024 13:13:54 -0400 Subject: [PATCH] Add FXIOS-9150 [New Close Button] documentation --- .../Documentation.docc/ComponentLibrary.md | 1 + .../General Components/CloseButton.md | 27 ++++++++++++++++++ .../Resources/CloseButton-dark.png | Bin 0 -> 1074 bytes .../Resources/CloseButton.png | Bin 0 -> 969 bytes .../BottomSheetComponentViewModel.swift | 2 +- 5 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 BrowserKit/Sources/ComponentLibrary/Documentation.docc/General Components/CloseButton.md create mode 100644 BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton-dark.png create mode 100644 BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton.png diff --git a/BrowserKit/Sources/ComponentLibrary/Documentation.docc/ComponentLibrary.md b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/ComponentLibrary.md index eaaf472d0c66..af9b67f2616b 100644 --- a/BrowserKit/Sources/ComponentLibrary/Documentation.docc/ComponentLibrary.md +++ b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/ComponentLibrary.md @@ -31,6 +31,7 @@ Buildings blocks are classes uses by devs to enabled General or Feature componen - ``BottomSheetViewController`` - ``CardView`` +- ``CloseButton`` - ``CollapsibleCardView`` - ``ContextualHintView`` - ``LinkButton`` diff --git a/BrowserKit/Sources/ComponentLibrary/Documentation.docc/General Components/CloseButton.md b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/General Components/CloseButton.md new file mode 100644 index 000000000000..e594df35fb50 --- /dev/null +++ b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/General Components/CloseButton.md @@ -0,0 +1,27 @@ +# ``ComponentLibrary/CloseButton`` + +The button which is used for closing a window. + +## Overview + +The `CloseButton` is a subclass of the `UIButton`. This means properties of the `UIButton` are accessible, but for easy conveniance it's recommended to configure the button title, font and accessibility identifier through it's' view model ``CloseButtonViewModel``. The button size shouldn't be adjusted and should be used as is. + +## Illustration + +> This image is illustrative only. For precise examples of iOS implementation, please run the SampleApplication. + +@TabNavigator { + @Tab("Light") { + ![The CloseButton on iOS](CloseButton) + } + + @Tab("Dark") { + ![The CloseButton Dark on iOS](CloseButton-dark) + } +} + +## Topics + +### View Model + +- ``CloseButtonViewModel`` diff --git a/BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton-dark.png b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..66aa59e9467a032425007e80b0ffbcd678c37d83 GIT binary patch literal 1074 zcmV-21kL-2P);)ip5zv7^_7)I39l|~VRs&(*0jmiKat5+L0NH#=U^WxT zF1~aKTL8p{+6w}Ljw$&`sR|(9YZzKuT4<8!2ZEp^wW0(>JLeZv7G9l zGcQ?BN5ROz$b^9b6z&k!p98_+$tZRPA%*}5u{jb94E{?Q7+C%w#7ue_7#8R-Fz`=B zh^ZMeFbL=~FzlO?Tv}8HHHMMNn1O*19{>;#N>B8k_>=$u061k>NoGw=04e|g00;m9 zhiL!=000010000Q0000000N)_00aO40096103M(N00aO40096103HAU008NU6+Zv~ z0)t6JK~zW$#h1Tt(?A@>U+j|^aMF&z993eeQxOK_R)P%)MU~)hfF-PK9XfPlB@2vQ zSU{>GBsP%Rr~^gC9e@@lA^{R0mBws|pzp|8=U|_0i0NDWEZPai)c41dU8u6r71&z-^CTpi5|3usQYPBksm#^XajTT(jP3@Bke*SC|oz4Rs9)3^lY-*UDok6>O6PK?nC5HV0 z9*sum+`Er%_i18>qBmQut7zZ81>3e`U1MNE*VgW0YjZmm^sg6-OP8>+awi72^rW2W zw4uz;oXo8&0`r+pYk75mI%jS&lq8tDmm8^UkwF$E!F*-@cJ~$;EE!};FpC43XyG$VXR4Hk!i6aWfh02TZPx~jBtO^mobbri7YbhMx(j9|Ms0J7X5x7&M8MG zb{t1u>m4N2^ANlW(ChW|ro{8wOci#$etz}qmv4yy`py1_WOz|1b6S=K!GfPxy{+G~ z;j&9r0I$GI6^BfrzB1}&)^QRZ1o@U%&r4=hK=g(}=b0bXI zO{IoFrr<|BFF1luEN@XbnS##Y&Fg(NnABqoI^JXqo_ywcW=^I>yOJeVB)NMzQw^&6 z@g6r>R*_NhWD0sD+7(mv8ia$);vfffywMnI5?NzkCZtDNUw@byzZdMKw&@LdmYIHx zW>CIPG-mWjWs3~5C<&$;q%kX7WGLqu6%e{X8nd#*+`8k8zy#6_(wI$K%*oukVlI;n sCt`2)5&d^VuftE|7e*gI89!~m08zqT;vgaaZ2$lO07*qoM6N<$f-?%Z!~g&Q literal 0 HcmV?d00001 diff --git a/BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton.png b/BrowserKit/Sources/ComponentLibrary/Documentation.docc/Resources/CloseButton.png new file mode 100644 index 0000000000000000000000000000000000000000..b435f82f84180ab0ef64d8cf84616dba8956f2ce GIT binary patch literal 969 zcmV;)12+7LP);)ip5zv7^_7)I39l|~VRs&(*0jmiKat5+L0NH#=U^WxT zF1~aKTL8p{+6w}Ljw$&`sR|(9YZzKuT4<8!2ZEp^wW0(>JLeZv7G9l zGcQ?BN5ROz$b^9b6z&k!p98_+$tZRPA%*}5u{jb94E{?Q7+C%w#7ue_7#8R-Fz`=B zh^ZMeFbL=~FzlO?Tv}8HHHMMNn1O*19{?@mN?wqf1z!LF061k>NoGw=04e|g00;m9 zhiL!=000010000Q0000000N)_00aO40096103M(N00aO40096103HAU008NU6+Zv~ z0vbs~K~zW$y_dmqf-n$<14eM1`Y1iDYysUZokZC^Lel7rVbly+XM?{$ijC8dpLX-4)?9_^&05jVB02GFs;un zUM@e};Bbui)&jcQ?agBG-e}WyQg&d@ULUPiC9Dqb3xx&Ka^U-_4rki>L@FGZw(oAP z!{>9q=@lq%x4Cr1U&q=zPTzVI?dD!^=zw$p1id+R(Lfa3?- zHemzUB?8=)XB<^n6*jfm7_?(_1|ve%m@n(rrFv**AK6b-zZ$x{>I~k;-&M rw>&PhcLx21(XJT)Sp(0r{