Kamishibai makes easy to create long tutorial.
Switch branches/tags
Nothing to show
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.
Example Support carthage Oct 12, 2017
Kamishibai initial commit Oct 2, 2017
Screenshots Add screen shots Oct 3, 2017
.gitignore initial commit Oct 2, 2017
.swift-version Update podspec file Oct 3, 2017
Kamishibai.podspec update Oct 24, 2017
LICENSE Initial commit Oct 2, 2017
README.md Update README.md Oct 24, 2017
_Pods.xcodeproj initial commit Oct 2, 2017

README.md

Kamishibai

CI Status Version License Platform Swift

Kamishibai makes easy to create long tutorial.

Features

sample

  • Manage progress of tutorial
  • Support presenting transitioning of UIViewController
  • Support push/pop transitioning of NavigationController
  • Focus with animation where you want
  • Support custom guide view

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

// create Kamishibai instance
let kamishibai = Kamishibai(initialViewController: self)

// append first scene and focus CGRect(x: 0, y: 100, width: 50, height: 50)
kamishibai.append(KamishibaiScene(scene: { (scene) in
    guard let vc = scene.kamishibai?.currentViewController as? UIViewController else { return }
    let frame = CGRect(x: 0, y: 100, width: 50, height: 50)
    scene.kamishibai?.focus.on(view: vc.navigationController?.view, focus: Focus.Rect(frame: frame))
    scene.fulfillWhenTapFocus()
}))

// append second scene and add customized view
kamishibai.append(KamishibaiScene(transition: .push(SecondViewController.create()), scene: { (scene) in
    let guide = SampleGuideView.create()
    scene.kamishibai?.focus.addCustomView(view: guide, position: .bottomRight(CGPoint.zero))
    scene.fulfillWhenTap(view: guide.button)
}))

// 
kamishibai.startStory()

Requirements

  • iOS 9.0
  • Swift 4.0

Installation

Cocoapods

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

pod "Kamishibai"

Carthage

To integrate into your Xcode project using Carthage, specify it in your Cartfile:

github "Matzo/Kamishibai"

Author

ksk.matsuo@gmail.com

License

Kamishibai is available under the MIT license. See the LICENSE file for more info.