Skip to content
Framework to Add a Apple Appstore like Animation when selecting a UICollectionViewCell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
UIExpandableCVCellKit.xcodeproj
UIExpandableCVCellKit
UIExpandableCVCellKitTests
README.md
UIExpandableCVCellKit.podspec

README.md

UIExpandableCVCellKit

A Framework to add a Apple Appstore like animation to expand the cell to fullscreen when selecting a UICollectionViewCell

Installation

  1. Install cocoapods
  2. add pod 'UIExpandableCVCellKit' to your Podfile
  3. run pod install from the command line your project directory with the Podfile

Setup

Required: UICollectionViewController:

  • Have your UICollectionView extend the ExpandableCVProtocol

  • Add this line to your viewDidAppear(_ animated:) delegate function: collectionView.isScrollEnabled = (isCellOpen) ? false : true

    This will ensure when you swap between apps, that the scrolling is set to the correct setting when you swap between apps

  • in collectionView(_ collectionView:, cellForItemAt indexPath:) dequeue your cell and then create the ExpandedCellViewModel and pass it to the cell using the ExpandableCVCellProtocol.configure(withOptions options: [ExpandableCellViewProperties]?, expandableCVProtocol: ExpandableCVProtocol?) function, this will help the cell configure itself with all the settings it needs to function.

    • You can further tweak the different settings for how cell expands, this is very useful where your collectionView is in a container and is smaller than view that you want to expand it to. Use the corresponding enum and add the associated value then pass all the enums as an array into the options.
  • in collectionView(_ collectionView:, didSelectItemAt indexPath:) impliment animateCellOpen(indexPath:) inside that delegate function to allow the cell to open properly. This is a manadatory implimentation.

UICollectionViewCell:

  • Have your UICollectionViewCell extend ExpandablerCVCellProtocol

  • Add setupPanGesture(selector: Selector) to your init(frame:) and init(coder:) initializers with your own gesturing funciton. I usually call mine cellGestured(), inside that @objc function I add the default cellGesturedLogic() function. You can of course override and write your own gesturing logic if required.

Optional:

  • Optionally you may impliment the following functions to add or write your own code to animate the cells open, close, or snap back:

    • func openCellHandler() -> (handler: Handler?, completion: Handler?, isAnimated: Bool)
    • func closeCellHandler() -> (handler: Handler?, completion: Handler?, isAnimated: Bool)
    • func snapBackCellHandler() -> (handler: Handler?, completion: Handler?, isAnimated: Bool)

    Example of how to the openCellHanlder() or any of the other optional handler functions:

     func openCellHandler() -> (handler: Handler?, completion: Handler?, isAnimated: Bool) {
    
     	let animations = {
     		// your code that you would like animated into this block or any code you would like handled
     	}
    
     	let completion = {
     		// any code you would like to run after the animations/handler
     	}
    
     	return (handler: animations, completion: completion, isAnimated: true)
     }
    

Optional

If you want to hide and show the status bar when showing and hiding the expandable collectionViewCell do the following:

  1. In your UICollectionView class

Add:

override var prefersStatusBarHidden: Bool {
	return statusBarShoudlBeHidden
}

override var preferredStatusBarUpdateAnimation: UIStatusBarAnimation {
	return .slide
}

You can choose another type of animation, if you like

  1. Optionally you can use func animateStatusBar(duration: TimeInterval) to hide or show the status bar when required. You should however set the setting for statusBarShouldBeHidden before you run this function.

For an example project please see https://github.com/yungdai/AppStoreAnimationDemo

You can’t perform that action at this time.