A lightweight swift library to build onboarding experiences.
Branch: master
Clone or download
Latest commit 20f3478 Oct 2, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Ahoy.xcodeproj Swift 4 support Oct 2, 2017
Ahoy.xcworkspace Initial version (#1) Mar 2, 2017
Example Swift 4 support Oct 2, 2017
Sources Swift 4 support Oct 2, 2017
Tests Initial version (#1) Mar 2, 2017
.gitignore Initial version (#1) Mar 2, 2017
.swift-version Swift 4 support Oct 2, 2017
Ahoy.podspec Swift 4 support Oct 2, 2017
CHANGELOG.md Initial version (#1) Mar 2, 2017
CONTRIBUTING.md Initial version (#1) Mar 2, 2017
Cartfile.private
Cartfile.resolved Initial version (#1) Mar 2, 2017
LICENSE Initial version (#1) Mar 2, 2017
README.md Swift 4 support Oct 2, 2017
README.pdf Initial version (#1) Mar 2, 2017
bottom.gif Initial version (#1) Mar 2, 2017
movie.gif Initial version (#1) Mar 2, 2017

README.md

Ahoy

Platform iOS Swift 3 compatible Carthage compatible CocoaPods compatible License: MIT

By Xmartlabs SRL.

Introduction

Ahoy is a swift library that helps you build awesome onboarding experiences for your users.

Usage

In order to setup your onboarding you need to define 2 components:

  • The specific view controller that you are going to use, which should subclass from OnboardingViewController. This will handle all the specific logic related to displaying the slides and managing any global control that you want to use (an skip button for example).
  • A Presenter which should implement the protocol OnboardingPresenter. This will handle all the specific functionality of each cell (which text goes where, the type of cells, etc.)

Basic setup

  • Create your own presenter implementation, either implementing OnboardingPresenter protocol or subclassing from BasePresenter.
  • Create your OnboardingViewController subclass and set the presenter property to an instance of your presenter's class. This must be done before calling super.viewDidLoad().

After this you are ready to go! You can add any other ui components that you want via IBOutlets or directly by code.

Example
import Ahoy
class MovieFanOnboardingController: OnboardingViewController {

    override func viewDidLoad() {
        presenter = MovieFanPresenter()
        presenter.onOnBoardingFinished = { [weak self] in
            _ = self?.navigationController?.popViewController(animated: true)
        }
        super.viewDidLoad()
    }

}

class MovieFanPresenter: BasePresenter {
  // Your presenter implementation's here
}

Callbacks

In order to manage user interaction, when the onboarding is finished, skipped or when a slide is being displayed. Ahoy provides a few helpers to manage this consistently:

  • onOnboardingSkipped: Is called by the controller when the user taps on the skip action.
  • onOnBoardingFinished: Is called by the controller when the user taps on finish.
  • visibilityChanged(for cell: UICollectionViewCell, at index: Int, amount: CGFloat): is called each time the visibility of a cell changes, this can be used to implement some cool animations between each cell.

BasePresenter

By default, Ahoy provides an implementation of OnboardingPresenter, BasePresenter which handles basic functionality and has some customization parameters:

public var cellBackgroundColor: UIColor
public var doneButtonColor: UIColor
public var doneButtonTextColor: UIColor
public var textColor: UIColor
public var swipeLabelText: String
public var titleFont: UIFont
public var bodyFont: UIFont
public var skipColor: UIColor
public var skipTitle: String
public var model: [OnboardingSlide]
public var onOnBoardingFinished: (() -> ())?
public var onOnboardingSkipped: (() -> ())?

BottomOnobardingController

Ahoy provides another implementation of the OnboardingViewController that has global controls at the bottom of the screen. The BottomOnobardingController uses BottomPresenter as a Presenter.

Requirements

  • iOS 9.0+
  • Xcode 9.0+

Getting involved

  • If you want to contribute please feel free to submit pull requests.
  • If you have a feature request please open an issue.
  • If you found a bug or need help please check older issues, FAQ and threads on StackOverflow (Tag 'Ahoy') before submitting an issue..

Before contribute check the CONTRIBUTING file for more info.

If you use Ahoy in your app We would love to hear about it! Drop us a line on twitter.

Examples

Follow these 3 steps to run Example project: Clone Ahoy repository, open Ahoy workspace and run the Example project.

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

To install Ahoy, simply add the following line to your Podfile:

pod 'Ahoy', '~> 2.0'

Carthage

Carthage is a simple, decentralized dependency manager for Cocoa.

To install Ahoy, simply add the following line to your Cartfile:

github "xmartlabs/Ahoy" ~> 2.0

Author

Change Log

This can be found in the CHANGELOG.md file.