Merge pull request #6 from maustinstar/new-features-0.1.0-dev

New features 0.1.0 dev

Author: maustinstar

Docs/Examples.md

@@ -0,0 +1,55 @@
+#  Examples
+
+## Basic Usage
+
+Embed your view content in a `ZStack` with the Drawer as the last element. The `heights` parameter defines a list of resting heights for the drawer.
+
+```swift
+ZStack {
+
+    ScrollView {
+        //...
+    }
+    
+    Drawer(heights: [100, 340]) {
+        Color.blue
+    }
+}
+```
+
+## Multi-height drawer with haptic impact
+
+<img src=https://raw.githubusercontent.com/maustinstar/swiftui-drawer/master/Docs/Media/white-drawer.gif width=200 />
+
+```swift
+Drawer {
+    ZStack {
+        
+        RoundedRectangle(cornerRadius: 12)
+            .foregroundColor(.white)
+            .shadow(radius: 100)
+        
+        VStack(alignment: .center) {
+            Spacer().frame(height: 4.0)
+            RoundedRectangle(cornerRadius: 3.0)
+                .foregroundColor(.gray)
+                .frame(width: 30.0, height: 6.0)
+            Spacer()
+        }
+    }
+}
+.rest(at: .constant([100, 340, UIScreen.main.bounds.height - 40]))
+.impact(.light)
+```
+
+## Example 2
+
+<img src=https://raw.githubusercontent.com/maustinstar/swiftui-drawer/master/Docs/Media/blue-drawer.gif width=200 />
+
+A basic two-height drawer.
+
+```swift
+Drawer {
+    Color.blue
+}.rest(at: .constant([100, 340]))
+```

Previews/blue-drawer.gif renamed to Docs/Media/blue-drawer.gif

@@ -0,0 +1,148 @@
+#  Reference
+
+## View Modifiers
+
+Following SwiftUI's declarative syntax, these view modifiers return a modified Drawer.
+
+### Rest
+
+#### 🛏️ `rest(at heights: Binding<[CGFloat]>) -> Drawer`
+
+Sets the active possible resting heights of the drawer.
+
+**Usage**
+Set a spring distance
+```swift
+Drawer {
+    Color.blue
+}.rest(at: $heights)
+```
+
+### Impact
+
+#### 💥 `impact(_: UIImpactFeedbackGenerator.FeedbackStyle) -> Drawer`
+
+Sets the haptic impact of the drawer when resting.
+
+**Feedback Style**
+Choose from the possible impact styles. [Apple Docs](https://developer.apple.com/documentation/uikit/uiimpactfeedbackgenerator/feedbackstyle)
+```swift
+public enum FeedbackStyle : Int {
+
+    /// A collision between small, light user interface elements.
+    case light = 0
+    
+    /// A collision between moderately sized user interface elements.
+    case medium = 1
+    
+    /// A collision between large, heavy user interface elements.
+    case heavy = 2
+    
+    @available(iOS 13.0, *)
+    case soft = 3
+    
+    @available(iOS 13.0, *)
+    case rigid = 4
+}
+```
+
+**Usage**
+```swift
+Drawer(heights: [100, 340]) {
+    Color.blue
+}.impact(.light)
+```
+
+### Spring
+
+#### 🪀 `spring(_: CGFloat) -> Drawer`
+
+Sets the springiness of the drawer when pulled past boundaries.
+
+**Spring Level**
+A positive number, in pixels, to define how far the drawer can be streched beyond bounds.
+
+A spring of 0 will not let the user drag the drawer beyond the bound of the minimum and maximum heights.
+
+A positive spring level will allow users to pull the drawer a specified number of pixels beyond the bounds. The user's drag displacement is transformed by a [logistic curve](https://en.wikipedia.org/wiki/Logistic_function) for a natural hard-spring pull that reaches an asymptote.
+
+Default is 12px.
+
+**Usage**
+Set a spring distance
+```swift
+Drawer(heights: [100, 340]) {
+    Color.blue
+}.spring(20)
+```
+
+Toggle a spring distance
+```swift
+Drawer(heights: [100, 340]) {
+    Color.blue
+}.spring(isSpringy ? 0 : 20)
+```
+
+### OnRest
+
+#### 😴 `onRest(_: @escaping (_ height: CGFloat) -> ()) -> Drawer`
+
+A callback to receive updates when the drawer reaches a new resting level.
+
+**Closure**
+This closure is executed every time the drawer reaches a new resting hieght. Use this when you want to receive updates on the drawer's changes. 
+
+**Usage**
+Lock into a fixed position.
+```swift
+Drawer(heights: [100, 340]) {
+    Color.blue
+}.onRest { (restingHeight) in
+    print(restingHeight)
+}
+```
+
+### OnLayoutForSizeClass
+
+#### 🔄 `onLayoutForSizeClass(_: @escaping (SizeClass) -> ()) -> Drawer`
+
+A callback to receive updates when the drawer is layed out for a new size class.
+
+**Closure**
+This closure is executed every time the device layout changes (portrait, landscape, and splitview).
+Use this to modify your view when the drawer's layout changes. 
+
+**Usage**
+Alter the resting heights and alignment when the screen layout changes.
+```swift
+Drawer(heights: [100, 340]) {
+    Color.blue
+}
+.rest(at: $heights)
+.onLayoutForSizeClass { (sizeClass) in
+    switch (sizeClass.horizontal, sizeClass.vertical) {
+    case (.compact, .compact):
+        // smaller iPhone landscape
+        self.heights = [100, UIScreen.main.bounds.height - 40]
+        break
+    case (.compact, .regular):
+        // iPhone portrait
+        // iPad portrait splitview
+        // iPad landscape smaller splitview
+        self.heights = [100, 340, UIScreen.main.bounds.height - 40]
+        break
+    case (.regular, .compact):
+        // larger iPhone landscape
+        self.heights = [100, UIScreen.main.bounds.height - 40]
+        break
+    case (.regular, .regular):
+        // iPad fullscreen
+        // iPad landscape larger splitview
+        self.heights = [100, UIScreen.main.bounds.height - 40]
+        break
+    default:
+        // Unknown layout
+        break
+    }
+}
+```