devmario/koloda

KolodaView is a class designed to simplify the implementation of Tinder like cards on iOS.

KolodaView

Check this article on our blog. And another one article on our blog

Purpose

KolodaView is a class designed to simplify the implementation of Tinder like cards on iOS. It adds convenient functionality such as a UITableView-style dataSource/delegate interface for loading views dynamically, and efficient view loading, unloading .

Supported OS & SDK Versions

• Supported build target - iOS 9.0 (Xcode 7)

ARC Compatibility

KolodaView requires ARC.

Сocoapods version

pod 'Koloda', '~> 2.0.10'

Thread Safety

KolodaView is subclassed from UIView and - as with all UIKit components - it should only be accessed from the main thread. You may wish to use threads for loading or updating KolodaView contents or items, but always ensure that once your content has loaded, you switch back to the main thread before updating the KolodaView.

Installation

To install via CocoaPods add this lines to your Podfile

use_frameworks!
pod "Koloda"

Note: Due to CocoaPods/CocoaPods#4420 issue there is problem with compiling project with Xcode 7.1 and CocoaPods v0.39.0. However there is a temporary workaround for this: Add next lines to the end of your Podfile

post_install do |installer|
    `find Pods -regex 'Pods/pop.*\\.h' -print0 | xargs -0 sed -i '' 's/\\(<\\)pop\\/\\(.*\\)\\(>\\)/\\"\\2\\"/'`
end

To install via Carthage add this lines to your Cartfile

github "Yalantis/Koloda" "carthage"

To install manually the KolodaView class in an app, just drag the KolodaView, DraggableCardView, OverlayView class files (demo files and assets are not needed) into your project. Also you need to install facebook-pop. Or add bridging header if you are using CocoaPods.

Properties

The KolodaView has the following properties:

	weak var dataSource: KolodaViewDataSource!

An object that supports the KolodaViewDataSource protocol and can provide views to populate the KolodaView.

	weak var delegate: KolodaViewDelegate?

An object that supports the KolodaViewDelegate protocol and can respond to KolodaView events.

    public var currentCardNumber

The index of front card in the KolodaView (read only).

    public var countOfCards

The count of cards in the KolodaView (read only). To set this, implement the kolodaNumberOfCards: dataSource method.

    var countOfVisibleCards

The count of displayed cards in the KolodaView.

Methods

The KolodaView class has the following methods:

	func reloadData()

This method reloads all KolodaView item views from the dataSource and refreshes the display.

func resetCurrentCardNumber()

This method resets currentCardNumber and calls reloadData, so KolodaView loads from the beginning.

	func revertAction()

Applies undo animation and decrement currentCardNumber.

	func applyAppearAnimation()

Applies appear animation.

	func swipeLeft() 

Applies swipe left animation and action, increment currentCardNumber.

	func swipeRight()

Applies swipe right animation and action, increment currentCardNumber.

    public func frameForCardAtIndex(index: UInt) -> CGRect 

Calculates frames for cards. Useful for overriding. See example to learn more about it.

Protocols

The KolodaView follows the Apple convention for data-driven views by providing two protocol interfaces, KolodaViewDataSource and KolodaViewDelegate. The KolodaViewDataSource protocol has the following methods:

	func koloda(kolodaNumberOfCards koloda:KolodaView) -> UInt

Return the number of items (views) in the KolodaView.

	func koloda(koloda: KolodaView, viewForCardAtIndex index: UInt) -> UIView

Return a view to be displayed at the specified index in the KolodaView.

   func koloda(koloda: KolodaView, viewForCardOverlayAtIndex index: UInt) -> OverlayView?

Return a view for card overlay at the specified index. For setting custom overlay action on swiping(left/right), you should override didSet of overlayState property in OverlayView. (See Example)

The KolodaViewDelegate protocol has the following methods:

    func koloda(koloda: KolodaView, didSwipedCardAtIndex index: UInt, inDirection direction: SwipeResultDirection)

This method is called whenever the KolodaView swipes card. It is called regardless of whether the card was swiped programatically or through user interaction.

    func koloda(kolodaDidRunOutOfCards koloda: KolodaView)

This method is called when the KolodaView has no cards to display.

	func koloda(koloda: KolodaView, didSelectCardAtIndex index: UInt)

This method is called when one of cards is tapped.

    func koloda(kolodaShouldApplyAppearAnimation koloda: KolodaView) -> Bool

This method is fired on reload, when any cards are displayed. If you return YES from the method or don't implement it, the koloda will apply appear animation.

    func koloda(kolodaShouldMoveBackgroundCard koloda: KolodaView) -> Bool

This method is fired on start of front card swipping. If you return YES from the method or don't implement it, the koloda will move background card with dragging of front card.

    func koloda(kolodaShouldTransparentizeNextCard koloda: KolodaView) -> Bool

This method is fired on koloda's layout and after swiping. If you return YES from the method or don't implement it, the koloda will transparentize next card below front card.

    func koloda(kolodaBackgroundCardAnimation koloda: KolodaView) -> POPPropertyAnimation?

Return a pop frame animation to be applied to backround cards after swipe. This method is fired on swipping, when any cards are displayed. If you don't return frame animation, or return nil(don't implement this method), the koloda will apply default animation.

func koloda(koloda: KolodaView, draggedCardWithFinishPercent finishPercent: CGFloat, inDirection direction: SwipeResultDirection)

This method is called whenever the KolodaView recognizes card dragging event.

func koloda(kolodaSwipeThresholdMargin koloda: KolodaView) -> CGFloat?

Return the distance that a card may be dragged in order to trigger a swipe. The default behavior (or returning NIL) will set this threshold to half of the card's width

func koloda(kolodaDidResetCard koloda: KolodaView)

This method is fired after resetting the card.

func koloda(koloda: KolodaView, didShowCardAtIndex index: UInt)

This method is called after a card has been shown, after animation is complete

Release Notes

Version 2.0

• Swift 2.0 support

Version 1.1

• New delegate methods
• Fixed minor issues

Version 1.0

• Release version.

Let us know!

We’d be really happy if you sent us links to your projects where you use our component. Just send an email to [email protected] And do let us know if you have any questions or suggestion regarding the animation.

P.S. We’re going to publish more awesomeness wrapped in code and a tutorial on how to make UI for iOS (Android) better than better. Stay tuned!

License

The MIT License (MIT)

Copyright © 2015 Yalantis

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.