Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/m1entus/MZFormSheetPresentationController

MZFormSheetPresentationController provides an alternative to the native iOS UIModalPresentationFormSheet, adding support for iPhone and additional opportunities to setup UIPresentationController size and feel form sheet.
https://github.com/m1entus/MZFormSheetPresentationController

Last synced: about 1 month ago
JSON representation

MZFormSheetPresentationController provides an alternative to the native iOS UIModalPresentationFormSheet, adding support for iPhone and additional opportunities to setup UIPresentationController size and feel form sheet.

Awesome Lists containing this project

README 

        
[![](http://inspace.io/github-cover.jpg)](http://inspace.io)



MZFormSheetPresentationController

===========



`MZFormSheetPresentationController` provides an alternative to the native iOS UIModalPresentationFormSheet, adding support for iPhone and additional opportunities to setup controller size and feel form sheet.



`MZFormSheetPresentationController` also has a number of predefined transitions so you can customize whether the modal form slides in, fades in, bounces in or you can create your own custom transition.  There are also a number of properties for customizing the exact look and position of the form. It support also pan gesture dismissing.



This project is continuation of [`MZFormSheetController`](https://github.com/m1entus/MZFormSheetController) which allow you to make form sheet when deployment target is set to >iOS5 but use some tricky UIWindow hacks.



Here are a couple of images showing `MZFormSheetPresentationController` in action:



[![](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/animation2.gif)](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/animation2.gif)

[![](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/animation1.gif)](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/animation1.gif)

[![](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/screen2.png)](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/screen2.png)

[![](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/screen1.png)](https://raw.github.com/m1entus/MZFormSheetPresentationController/master/Screens/screen1.png)



## 2.x Change Log:

* Fully tested and certified for iOS 9

* Support for tvOS

* Fixed issue with text size based on size class

* Fixed autolayout issues

* Added dissmisal pan gesture on each direction

* Rewritten `MZFormSheetPresentationController` to use `UIPresentationController`

* Support for adding shadow to content view

* Added frame configuration handler which allow you to change frame during rotation and animations

* Added `shouldCenterHorizontally` property

* Allowed make your custom animator to support native transitions

* Allow to make dynamic contentViewSize depents on displayed UIViewController



## Upgrade from 1.x



As a major version change, the API introduced in 2.0 is not backward compatible with 1.x integrations. Upgrading is straightforward.

* Use `MZFormSheetPresentationViewController` instead of `MZFormSheetPresentationController`



* `MZFormSheetPresentationController` now inherits from `UIPresentationController` and manage presentation of popup



* `MZFormSheetPresentationViewController` have property `presentationController` which allows you customization presented content view



* `MZFormSheetPresentationController registerTransitionClass` is now `MZTransition registerTransitionClass`



* `func entryFormSheetControllerTransition(formSheetController: MZFormSheetPresentationController, completionHandler: MZTransitionCompletionHandler)` changed to `func entryFormSheetControllerTransition(formSheetController: UIViewController, completionHandler: MZTransitionCompletionHandler)` which formSheetController frame is equal to contentViewSize with view origin.



## Requirements



MZFormSheetPresentationController requires either iOS 8.x and above.



## Installation

###[Carthage](https://github.com/Carthage/Carthage)



Add the following line to your `Cartfile`.



```github "m1entus/MZFormSheetPresentationController" "master"```



Then run `carthage update --no-use-binaries` or just `carthage update`. 



After building the framework you will need to add it to your project and import it using the Framework header:



```#import ```



For further details on the installation and usage of Carthage, visit [it's project page](https://github.com/Carthage/Carthage).



###[CocoaPods](https://github.com/CocoaPods/CocoaPods)



Add the following line to your `Podfile`.



```

# Uncomment this line to define a global platform for your project

platform :ios, '8.0'

# Uncomment this line if you're using Swift

use_frameworks!



target 'ProjectName' do

    pod 'MZFormSheetPresentationController'

end

```



Then run `pod install --verbose` or just `pod install`. For details of the installation and usage of CocoaPods, visit [it's project page](https://github.com/CocoaPods/CocoaPods).



## How To Use



There are two example projects, one is for Objective-C second is for Swift.



Let's start with a simple example



Objective-C

``` objective-c

UINavigationController *navigationController = [self.storyboard instantiateViewControllerWithIdentifier:@"formSheetController"];

MZFormSheetPresentationViewController *formSheetController = [[MZFormSheetPresentationViewController alloc] initWithContentViewController:navigationController];

formSheetController.presentationController.contentViewSize = CGSizeMake(250, 250); // or pass in UILayoutFittingCompressedSize to size automatically with auto-layout



[self presentViewController:formSheetController animated:YES completion:nil];

```



Swift

```swift

let navigationController = self.storyboard!.instantiateViewController(withIdentifier: "formSheetController") as! UINavigationController

let formSheetController = MZFormSheetPresentationViewController(contentViewController: navigationController)

formSheetController.presentationController?.contentViewSize = CGSize(width: 250, height: 250)  // or pass in UILayoutFittingCompressedSize to size automatically with auto-layout



self.present(formSheetController, animated: true, completion: nil)

```



This will display view controller inside form sheet container.



If you want to dismiss form sheet controller, use default dismissing view controller action.



Objective-C

```objective-c

[self dismissViewControllerAnimated:YES completion:nil];

```



Swift

```swift

self.dismiss(animated: true, completion: nil)

```



Easy right ?!



## Passing data

If you want to pass data to presenting view controller, you are doing it like normal. Just remember that IBOutlets are initialized after viewDidLoad, if you don't want to create additional properies, you can always use completion handler `willPresentContentViewControllerHandler` to pass data directly to outlets. It is called after viewWillAppear and before `MZFormSheetPresentationViewController` animation.



Objective-C

```objective-c

MZFormSheetPresentationViewController *formSheetController = [[MZFormSheetPresentationViewController alloc] initWithContentViewController:navigationController];



PresentedTableViewController *presentedViewController = [navigationController.viewControllers firstObject];

presentedViewController.textFieldBecomeFirstResponder = YES;

presentedViewController.passingString = @"PASSSED DATA!!";



formSheetController.willPresentContentViewControllerHandler = ^(UIViewController *vc) {

    UINavigationController *navigationController = (id)vc;

    PresentedTableViewController *presentedViewController = [navigationController.viewControllers firstObject];

    [presentedViewController.view layoutIfNeeded];

    presentedViewController.textField.text = @"PASS DATA DIRECTLY TO OUTLET!!";

};



[self presentViewController:formSheetController animated:YES completion:nil];

```



Swift

```swift

let formSheetController = MZFormSheetPresentationViewController(contentViewController: navigationController)



let presentedViewController = navigationController.viewControllers.first as! PresentedTableViewController

presentedViewController.textFieldBecomeFirstResponder = true

presentedViewController.passingString = "PASSED DATA"



formSheetController.willPresentContentViewControllerHandler = { vc in

    let navigationController = vc as! UINavigationController

    let presentedViewController = navigationController.viewControllers.first as! PresentedTableViewController

    presentedViewController.view?.layoutIfNeeded()

    presentedViewController.textField?.text = "PASS DATA DIRECTLY TO OUTLET!!"

}



self.present(formSheetController, animated: true, completion: nil)

```



## Using pan gesture to dismiss



```objective-c

typedef NS_OPTIONS(NSUInteger, MZFormSheetPanGestureDismissDirection) {

    MZFormSheetPanGestureDismissDirectionNone = 0,

    MZFormSheetPanGestureDismissDirectionUp = 1 << 0,

    MZFormSheetPanGestureDismissDirectionDown = 1 << 1,

    MZFormSheetPanGestureDismissDirectionLeft = 1 << 2,

    MZFormSheetPanGestureDismissDirectionRight = 1 << 3,

    MZFormSheetPanGestureDismissDirectionAll = MZFormSheetPanGestureDismissDirectionUp | MZFormSheetPanGestureDismissDirectionDown | MZFormSheetPanGestureDismissDirectionLeft | MZFormSheetPanGestureDismissDirectionRight

};

```

```objective-c

UINavigationController *navigationController = [self formSheetControllerWithNavigationController];

MZFormSheetPresentationViewController *formSheetController = [[MZFormSheetPresentationViewController alloc] initWithContentViewController:navigationController];



formSheetController.interactivePanGestureDissmisalDirection = MZFormSheetPanGestureDismissDirectionAll;



[self presentViewController:formSheetController animated:YES completion:nil];



```



## Blur background effect



It is possible to display blurry background, you can set `MZFormSheetPresentationController` default appearance or directly to `MZFormSheetPresentationController`



Objective-C

```objective-c

// Blur will be applied to all MZFormSheetPresentationControllers by default

[[MZFormSheetPresentationController appearance] setShouldApplyBackgroundBlurEffect:YES];



or



// This will set to only one instance

formSheetController.shouldApplyBackgroundBlurEffect = YES;

```



Swift

```swift

// Blur will be applied to all MZFormSheetPresentationControllers by default

MZFormSheetPresentationController.appearance().shouldApplyBackgroundBlurEffect = true



or



// This will set to only one instance

formSheetController.shouldApplyBackgroundBlurEffect = true

```



## Transitions



MZFormSheetPresentationViewController has predefined couple transitions.



Objective-C

``` objective-c

typedef NS_ENUM(NSInteger, MZFormSheetPresentationTransitionStyle) {

 MZFormSheetPresentationTransitionStyleSlideFromTop = 0,

 MZFormSheetPresentationTransitionStyleSlideFromBottom,

 MZFormSheetPresentationTransitionStyleSlideFromLeft,

 MZFormSheetPresentationTransitionStyleSlideFromRight,

 MZFormSheetPresentationTransitionStyleSlideAndBounceFromTop,

 MZFormSheetPresentationTransitionStyleSlideAndBounceFromBottom,

 MZFormSheetPresentationTransitionStyleSlideAndBounceFromLeft,

 MZFormSheetPresentationTransitionStyleSlideAndBounceFromRight,

 MZFormSheetPresentationTransitionStyleFade,

 MZFormSheetPresentationTransitionStyleBounce,

 MZFormSheetPresentationTransitionStyleDropDown,

 MZFormSheetPresentationTransitionStyleCustom,

 MZFormSheetPresentationTransitionStyleNone,

};

```



If you want to use them you will have to just assign `contentViewControllerTransitionStyle` property



Objective-C

``` objective-c

formSheetController.contentViewControllerTransitionStyle = MZFormSheetPresentationTransitionStyleFade;

```



You can also create your own transition by implementing `MZFormSheetPresentationViewControllerTransitionProtocol` protocol and register your transition class as a custom style.



Objective-C

``` objective-c

@interface CustomTransition : NSObject 

@end



[MZTransition registerTransitionClass:[CustomTransition class] forTransitionStyle:MZFormSheetTransitionStyleCustom];



formSheetController.contentViewControllerTransitionStyle = MZFormSheetTransitionStyleCustom;

```



Swift

```swift

class CustomTransition: NSObject, MZFormSheetPresentationViewControllerTransitionProtocol {

}



MZTransition.registerClass(CustomTransition.self, for: .custom)



formSheetController.contentViewControllerTransitionStyle = .custom

```



if you are creating own transition you have to call completionBlock at the end of animation.



Objective-C

```objective-c

- (void)exitFormSheetControllerTransition:(nonnull UIViewController *)presentingViewController

                        completionHandler:(nonnull MZTransitionCompletionHandler)completionHandler {

    CGRect formSheetRect = presentingViewController.view.frame;

    formSheetRect.origin.x = [UIScreen mainScreen].bounds.size.width;



    [UIView animateWithDuration:0.3

                          delay:0

                        options:UIViewAnimationOptionCurveEaseIn

                     animations:^{

                         presentingViewController.view.frame = formSheetRect;

                     }

                     completion:^(BOOL finished) {

                         completionHandler();

                     }];

}

```



Swift

```swift

func exitFormSheetControllerTransition(_ presentingViewController: UIViewController, completionHandler: @escaping MZTransitionCompletionHandler) {

    var formSheetRect = presentingViewController.view.frame

    formSheetRect.origin.x = UIScreen.main.bounds.width



    UIView.animate(withDuration: 0.3, delay: 0.0, options: UIView.AnimationOptions.curveEaseIn, animations: {

        presentingViewController.view.frame = formSheetRect

    }, completion: {(value: Bool)  -> Void in

        completionHandler()

    })

}

```



## Transparent Touch Background



If you want to have access to the controller that is below MZFormSheetPresentationController, you can set property `transparentTouchEnabled` and background view controller will get all touches.



Objective-C

```objective-c

MZFormSheetPresentationViewController *formSheetController = [[MZFormSheetPresentationViewController alloc] initWithContentViewController:viewController];

formSheetController.presentationController.transparentTouchEnabled = YES;

```



Swift

```swift

let formSheetController = MZFormSheetPresentationViewController(contentViewController: viewController)

formSheetController.presentationController?.isTransparentTouchEnabled = true

```



## Completion Blocks



``` objective-c

/**

 The handler to call when presented form sheet is before entry transition and its view will show on window.

 */

@property (nonatomic, copy, nullable) MZFormSheetPresentationViewControllerCompletionHandler willPresentContentViewControllerHandler;



/**

 The handler to call when presented form sheet is after entry transition animation.

 */

@property (nonatomic, copy, nullable) MZFormSheetPresentationViewControllerCompletionHandler didPresentContentViewControllerHandler;



/**

 The handler to call when presented form sheet will be dismiss, this is called before out transition animation.

 */

@property (nonatomic, copy, nullable) MZFormSheetPresentationViewControllerCompletionHandler willDismissContentViewControllerHandler;



/**

 The handler to call when presented form sheet is after dismiss.

 */

@property (nonatomic, copy, nullable) MZFormSheetPresentationViewControllerCompletionHandler didDismissContentViewControllerHandler;

```



## Autolayout



MZFormSheetPresentationController supports autolayout.



## Storyboard



MZFormSheetPresentationController supports storyboard.



MZFormSheetPresentationViewControllerSegue is a custom storyboard segue which use default MZFormSheetPresentationController settings.



If you want to get acces to form sheet controller and pass data using storyboard segue, the code will look like this:



Objective-C

```objective-c

- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender {

    if ([segue.identifier isEqualToString:@"segue"]) {

        MZFormSheetPresentationControllerSegue *presentationSegue = (id)segue;

        presentationSegue.formSheetPresentationController.presentationController.shouldApplyBackgroundBlurEffect = YES;

        UINavigationController *navigationController = (id)presentationSegue.formSheetPresentationController.contentViewController;

        PresentedTableViewController *presentedViewController = [navigationController.viewControllers firstObject];

        presentedViewController.textFieldBecomeFirstResponder = YES;

        presentedViewController.passingString = @"PASSSED DATA!!";

    }

}

```



Swift

```swift

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {

    if let identifier = segue.identifier {

        if identifier == "segue" {

            let presentationSegue = segue as! MZFormSheetPresentationViewControllerSegue

            presentationSegue.formSheetPresentationController.presentationController?.shouldApplyBackgroundBlurEffect = true

            let navigationController = presentationSegue.formSheetPresentationController.contentViewController as! UINavigationController

            let presentedViewController = navigationController.viewControllers.first as! PresentedTableViewController

            presentedViewController.textFieldBecomeFirstResponder = true

            presentedViewController.passingString = "PASSED DATA"

        }

    }

}

```



## ARC



MZFormSheetPresentationController uses ARC.



## App Extensions



Some position calculations access [UIApplication sharedApplication] which is not permitted in application extensions. If you want to use MZFormSheetPresentationController in extensions add the MZ_APP_EXTENSIONS=1 preprocessor macro in the corresponding target.



If you use Cocoapods you can use a post install hook to do that:

```ruby

post_install do |installer|

    installer.pods_project.targets.each do |target|

        if target.name == "MZFormSheetPresentationController"

            target.build_configurations.each do |config|

                config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)']

                config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] << 'MZ_APP_EXTENSIONS=1'

            end

        end

    end

end

```



## Contact



[Michal Zaborowski](http://github.com/m1entus)



[Twitter](https://twitter.com/iMientus)