Fork me on GitHub

Alex Rupérez

Link: http://j.mp/2Nqa8Am
Published: 25 Feb 11:49
View on GitHub


View README


🎪 Rideau

Rideau is a drawer UI similar to what Apple's apps use. (e.g Maps, Shortcuts)

🚀 Rideau is in release candidate!

Overview

  • 💎 Multiple snap points (e.g. most hidden, half visible, full visible, and we can add more snap points.)
  • 💎 Animations alongside moving (e.g. dimming background color)
  • 💎 Completely handling scrolling of scrollview inside RideauView
  • 💎 Ability to resize based on intrinsic content size of view that RideauView has

RideauView allows for flexible snap points. Snap points pertains to specified offsets where the draggable view "snaps to" when the dragging has ended. There are usually 2 or 3 snap points.


Objects we will commonly use:

  • RideauView
  • RideauViewController
  • RideauSnapPoint

RideauView is the core object in this library. We typically add our own view to RideauView.

RideauViewController contains a RideauView. It allows us to present the RideauView as modal dialog.

RideauSnapPoint defines where the content view stops.

🔶 Requirements

iOS 10.0+ Xcode 10.1+ Swift 4.2+

📱 Features

  • Multiple snap-point
  • Smooth integration with dragging and UIScrollView's scrolling.
  • Tracking UIScrollView automatically
  • Set UIScrollView to track manually
  • Use UIViewPropertyAnimator between snap-points.

👨🏻‍💻 Usage

Present inline

let rideauView = RideauView(frame: .zero) { (config) in
  config.snapPoints = [.autoPointsFromBottom, .fraction(0.6), .fraction(1)]
}
  
let someView = ...

rideauView.containerView.set(bodyView: container.view, options: .strechDependsVisibleArea)

Present with Modal Presentation

let targetViewController: YourViewController = ...

let controller = RideauViewController(
  bodyViewController: targetViewController,
  configuration: {
    var config = RideauView.Configuration()
    config.snapPoints = [.autoPointsFromBottom, .fraction(1)]
    return config
}(),
  initialSnapPoint: .autoPointsFromBottom
)

present(controller, animated: true, completion: nil)

Multiple SnapPoints

We can define snap-point with RideauSnapPoint.

public enum RideauSnapPoint : Hashable {
  
  case fraction(CGFloat)
  case pointsFromTop(CGFloat)
  case pointsFromBottom(CGFloat)
  case autoPointsFromBottom
}
config.snapPoints = [.pointsFromBottom(200), .fraction(0.5), .fraction(0.8), .fraction(1)]

⚙️ Details

RideauContainerView has two ways of resizing content view which is added.

  • RideauContainerView.ResizingOption
    • noResize
    • resizeToVisibleArea
final class RideauContainerView : UIView {
  public func set(bodyView: UIView, resizingOption: ResizingOption)
}

🔌 Components

Rideau provides the following components that may help us.

RideauMaskedCornerRoundedViewController

A Container view controller that implements masked rounded corner interface and has some options.

  • More customizable
let targetViewController: YourViewController = ...
let toDisplayViewController = RideauMaskedCornerRoundedViewController(viewController: targetViewController)

let controller = RideauViewController(
  bodyViewController: RideauMaskedCornerRoundedViewController(viewController: target),
  ...

RideauMaskedCornerRoundedView

  • More customizable

RideauThumbView

  • More customizable

Installation

CocoaPods

Rideau is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'Rideau'

Carthage

For Carthage, add the following to your Cartfile:

github "muukii/Rideau"

What's using Rideau

Author

Contributors

License

Rideau is released under the MIT license.