chore: update docs

gtokman · May 8, 2021 · 005c4c4 · 005c4c4
1 parent 00b9169
commit 005c4c4
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 3 deletions.
diff --git a/Documentation/Reference/ExtensionKit/README.md b/Documentation/Reference/ExtensionKit/README.md
@@ -10,6 +10,7 @@
 ## Enums
 
 -   [CLLocation.GeocodeError](enums/CLLocation.GeocodeError.md)
+-   [Height](enums/Height.md)
 -   [PrintEvent](enums/PrintEvent.md)
 -   [UIImage.ArrowDirection](enums/UIImage.ArrowDirection.md)
 -   [UIView.GradientLayerChangingDirection](enums/UIView.GradientLayerChangingDirection.md)
@@ -62,4 +63,4 @@
 -   [dprint(____)](methods/dprint(____).md)
 -   [sleep(duration_)](methods/sleep(duration_).md)
 
-This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2021-05-08 16:02:47 +0000
+This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2021-05-08 22:44:07 +0000
diff --git a/Documentation/Reference/ExtensionKit/enums/Height.md b/Documentation/Reference/ExtensionKit/enums/Height.md
@@ -0,0 +1,42 @@
+**ENUM**
+
+# `Height`
+
+```swift
+public enum Height: Equatable
+```
+
+Bottom sheet modal height
+
+## Cases
+### `low`
+
+```swift
+case low
+```
+
+Third of Screen size
+
+### `mid`
+
+```swift
+case mid
+```
+
+Half of Screen size
+
+### `full`
+
+```swift
+case full
+```
+
+Full Screen size
+
+### `custom(_:)`
+
+```swift
+case custom(CGFloat)
+```
+
+Custom screen size
diff --git a/Documentation/Reference/ExtensionKit/extensions/View.md b/Documentation/Reference/ExtensionKit/extensions/View.md
@@ -679,4 +679,33 @@ Subscribe to the given notification
 | ---- | ----------- |
 | name | Notification name |
 | object | Object posting the notification |
-| action | Action to run when received |
+| action | Action to run when received |
+
+### `bottomSheet(isPresented:height:animation:thumbHidden:content:)`
+
+```swift
+func bottomSheet<Content: View>(
+    isPresented: Binding<Bool>,
+    height: Height = .mid,
+    animation: Animation = .easeInOut(duration: 0.3),
+    thumbHidden: Bool = false,
+    @ViewBuilder content: @escaping () -> Content
+) -> some View
+```
+
+Adds a bottom sheet to View
+- Parameters:
+  - isPresented: Binding for presenting the View
+  - height: Height, default .mid
+  - animation: Animation
+  - content: modal content
+- Returns: View
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| isPresented | Binding for presenting the View |
+| height | Height, default .mid |
+| animation | Animation |
+| content | modal content |
diff --git a/Documentation/Reference/ExtensionKit/structs/KeyboardInfo.md b/Documentation/Reference/ExtensionKit/structs/KeyboardInfo.md
@@ -3,7 +3,7 @@
 # `KeyboardInfo`
 
 ```swift
-public struct KeyboardInfo
+public struct KeyboardInfo: Equatable
 ```
 
 Struct modeling keyboard updates