kam

Kamishibai

Kamishibai makes easy to create long tutorial.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

91

Maintenance

Last Commit

4yrs ago

Contributors

1

Package

Dependencies

0

License

MIT

Categories

Readme

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100