https://github.com/xmartlabs/ahoy
A lightweight swift library to build onboarding experiences.
https://github.com/xmartlabs/ahoy
ios onboarding swift ui
Last synced: about 2 months ago
JSON representation
A lightweight swift library to build onboarding experiences.
- Host: GitHub
- URL: https://github.com/xmartlabs/ahoy
- Owner: xmartlabs
- License: mit
- Created: 2017-02-15T12:26:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T18:21:50.000Z (about 8 years ago)
- Last Synced: 2025-08-10T17:17:19.256Z (about 2 months ago)
- Topics: ios, onboarding, swift, ui
- Language: Swift
- Homepage:
- Size: 1020 KB
- Stars: 52
- Watchers: 11
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ahoy
By [Xmartlabs SRL](http://xmartlabs.com).
## 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
```swift
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:
```swift
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](#faq) and threads on [StackOverflow](http://stackoverflow.com/questions/tagged/Ahoy) (Tag 'Ahoy') before submitting an issue.**.
Before contribute check the [CONTRIBUTING](https://github.com/xmartlabs/Ahoy/blob/master/CONTRIBUTING.md) file for more info.
If you use **Ahoy** in your app We would love to hear about it! Drop us a line on [twitter](https://twitter.com/xmartlabs).
## Examples
Follow these 3 steps to run Example project: Clone Ahoy repository, open Ahoy workspace and run the *Example* project.
## Installation
#### CocoaPods
[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects.
To install Ahoy, simply add the following line to your Podfile:
```ruby
pod 'Ahoy', '~> 2.0'
```
#### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a simple, decentralized dependency manager for Cocoa.
To install Ahoy, simply add the following line to your Cartfile:
```ogdl
github "xmartlabs/Ahoy" ~> 2.0
```
## Author
* [Mauricio Cousillas](https://github.com/mcousillas6)
# Change Log
This can be found in the [CHANGELOG.md](CHANGELOG.md) file.