PartyPicksVerticalFlowLayout 1.0.1

PartyPicksVerticalFlowLayout 1.0.1

TestsTested
LangLanguage SwiftSwift
License MIT
ReleasedLast Release Nov 2017
SwiftSwift Version 3.2
SPMSupports SPM

Maintained by Felipe Ricieri.




PartyPicksVerticalFlowLayout

language
CI Status
Version
License
Platform

UICollectionViewFlowLayout used in PartyWith iOS App's Party Picks section (edit mode)

Example

Installation

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

pod "PartyPicksVerticalFlowLayout"

And then run:

$ pod install

Manual Installation

To manually install PartyPicksVerticalFlowLayout, simply add PartyPicksVerticalFlowLayout files to your project.

Example

To run the example project, clone the repo. No Cocoapods setup needed, the files are embeded.

Getting Start

Via Storyboard

You can easily set your UICollectionView's Flow Layout in your storyboard:

Storyboard settings

In your UIViewController, you'll need to implement the delegate property:

if  let flowLayout = collection.collectionViewLayout as? PartyPicksVerticalFlowLayout {
    // Your app will crash if you don't implement this property
    flowLayout.delegate = <#delegate here#>
}

Via Code

You can also set it in your UIViewController:

let flowLayout = PartyPicksVerticalFlowLayout(delegate: self) // Delegate is required
self.collectionView.collectionViewLayout = flowLayout

Additionally you can configure some extra properties:

let flowLayout = PartyPicksVerticalFlowLayout(delegate: self) // Delegate is required
self.collectionView.collectionViewLayout = flowLayout

flowLayout.cellHeight = 50
flowLayout.cellSpacing = 10
flowLayout.contentInset = UIEdgeInsets(top: 8, left: 8, bottom: 8, right: 8)

If you chose to implement PartyPicksVerticalFlowLayout via storyboard, you can custom these properties using the conditional cast operator:

if  let flowLayout = collection.collectionViewLayout as? PartyPicksVerticalFlowLayout {
    // Customize your flow layout
    flowLayout.cellHeight = 40
    flowLayout.cellSpacing = 8
    flowLayout.contentInset = UIEdgeInsets(top: 8, left: 8, bottom: 8, right: 8)
}

Delegate

In order to work properly, PartyPicksVerticalFlowLayout requires a PartyPicksVerticalFlowLayoutDelegate. You'll find these methods in this protocol:

public protocol PartyPicksVerticalFlowLayoutDelegate {
    
    /**
     * Tells the flow layout which should be the width for a given cell.
     */
    func collectionView(_ collectionView: UICollectionView, widthForCellAt indexPath: IndexPath, withHeight height: CGFloat) -> CGFloat
    
    /**
     * Tells the delegate when flow layout is all set.
     */
    func didPreparedFlowLayout()
}

Please look into the example project for more details about the implementation.

Maintance

Pull Requests are welcome 🙂. Let us know your thoughts!

License

MIT License

Copyright (c) 2017 PartyWith B.V.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.