Add FXIOS-7431 [v120] Add docc for bottom sheet (#16807)

* Add docc for bottom sheet * Revert package change
mozilla-mobile · Oct 13, 2023 · 375e1ad · 375e1ad
1 parent 21b3acd
commit 375e1ad
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 6 deletions.
diff --git a/BrowserKit/Sources/ComponentLibrary/BottomSheet/BottomSheetViewController.swift b/BrowserKit/Sources/ComponentLibrary/BottomSheet/BottomSheetViewController.swift
@@ -6,16 +6,17 @@ import Common
 import Foundation
 import UIKit
 
+/// Protocol followed by child of the bottom sheet, which holds the content shown in the bottom sheet.
 public protocol BottomSheetChild: UIViewController {
     /// Tells the child that the bottom sheet will get dismissed
     func willDismiss()
 }
 
+/// Protocol followed by the bottom sheet view controller. Gives the possibility to dismiss the bottom sheet.
 public protocol BottomSheetDismissProtocol {
     func dismissSheetViewController(completion: (() -> Void)?)
 }
 
-/// A container that present from the bottom as a sheet
 public class BottomSheetViewController: UIViewController,
                                         BottomSheetDismissProtocol,
                                         Themeable,

diff --git a/BrowserKit/Sources/ComponentLibrary/BottomSheet/BottomSheetViewModel.swift b/BrowserKit/Sources/ComponentLibrary/BottomSheet/BottomSheetViewModel.swift
@@ -5,6 +5,7 @@
 import Foundation
 import UIKit
 
+/// The view model used to configure a `BottomSheetViewController`
 public struct BottomSheetViewModel {
     private struct UX {
         static let cornerRadius: CGFloat = 8

diff --git a/...onentLibrary/Documentation.docc/General Components/BottomSheetViewController.md b/...onentLibrary/Documentation.docc/General Components/BottomSheetViewController.md
@@ -1,10 +1,16 @@
 # ``ComponentLibrary/BottomSheetViewController``
 
-TODO with FXIOS-7431
+The bottom sheet is a modal view presented from the bottom as a pop over.
 
 ## Overview
 
-TODO with FXIOS-7431
+The `BottomSheetViewController` is a subclass of the `UIViewController`. The bottom sheet content is another view controller embedded inside this parent view controller. The bottom sheet itself is shown as a popover, meaning it's type of modal. Bottom sheet can be dismissed from the close button, by doing a swipe gesture or by clicking outside the sheet itself. Those properties can be configured with it's view model ``BottomSheetViewModel``.
+
+## Illustration
+
+> This image are illustrative only. For precise examples of iOS implementation, please run the SampleApplication.
+
+![The BottomSheetViewController on iOS](BottomSheetView)
 
 ## Topics
 
@@ -16,4 +22,3 @@ TODO with FXIOS-7431
 
 - ``BottomSheetChild``
 - ``BottomSheetDismissProtocol``
-
diff --git a/...erKit/Sources/ComponentLibrary/Documentation.docc/Resources/BottomSheetView.png b/...erKit/Sources/ComponentLibrary/Documentation.docc/Resources/BottomSheetView.png
diff --git a/.../Sources/ComponentLibrary/Documentation.docc/Resources/BottomSheetView~dark.png b/.../Sources/ComponentLibrary/Documentation.docc/Resources/BottomSheetView~dark.png
diff --git a/...ryApp/SampleComponentLibraryApp/Assets.xcassets/bottomSheet-close.imageset/Theme=Dark.pdf b/...ryApp/SampleComponentLibraryApp/Assets.xcassets/bottomSheet-close.imageset/Theme=Dark.pdf
diff --git a/...yApp/SampleComponentLibraryApp/Assets.xcassets/bottomSheet-close.imageset/Theme=Light.pdf b/...yApp/SampleComponentLibraryApp/Assets.xcassets/bottomSheet-close.imageset/Theme=Light.pdf
diff --git a/.../bottomSheet-close.imageset/Contents.json → ...rcleFillExtraLarge.imageset/Contents.json b/.../bottomSheet-close.imageset/Contents.json → ...rcleFillExtraLarge.imageset/Contents.json
@@ -1,7 +1,7 @@
 {
   "images" : [
     {
-      "filename" : "Theme=Light.pdf",
+      "filename" : "crossCircleFillExtraLargeLight.pdf",
       "idiom" : "universal"
     },
     {
@@ -11,7 +11,7 @@
           "value" : "dark"
         }
       ],
-      "filename" : "Theme=Dark.pdf",
+      "filename" : "crossCircleFillExtraLargeDark.pdf",
       "idiom" : "universal"
     }
   ],

diff --git a/...yApp/Assets.xcassets/crossCircleFillExtraLarge.imageset/crossCircleFillExtraLargeDark.pdf b/...yApp/Assets.xcassets/crossCircleFillExtraLarge.imageset/crossCircleFillExtraLargeDark.pdf
diff --git a/...App/Assets.xcassets/crossCircleFillExtraLarge.imageset/crossCircleFillExtraLargeLight.pdf b/...App/Assets.xcassets/crossCircleFillExtraLarge.imageset/crossCircleFillExtraLargeLight.pdf
diff --git a/...nentLibraryApp/SampleComponentLibraryApp/BottomSheet/BottomSheetChildViewController.swift b/...nentLibraryApp/SampleComponentLibraryApp/BottomSheet/BottomSheetChildViewController.swift
@@ -64,6 +64,7 @@ class BottomSheetChildViewController: UIViewController, BottomSheetChild, Themea
     // MARK: Themeable
 
     func applyTheme() {
+        contentLabel.textColor = themeManager.currentTheme.colors.textPrimary
         view.backgroundColor = themeManager.currentTheme.colors.layer1
     }
 }