Tokui

Tokui is a library with a ready to use tutorial screen that lights items, written in Swift.
(Swift始めて2週間ちょいの初学者がお勉強目的で作ったので、今見返すとあんまよくないですこれ。)

Preview

Installation

CocoaPods

You can use CocoaPods to install Tokui by adding it to your Podfile:

pod 'Tokui'

To get the full benefits, import Tokui

import Tokui

Manually

Download and drop Tokui in your project.
Congratulations!

Usage example

import Tokui

let tokui = TokuiViewController()

//Lighting target Items
tokui.add(target: button , message:"You tapped here." , position: .above)
tokui.add(target: label , message:"Tokui is a comedian of the Japanese comedy duo Tutorial.")

tokui.PreparePages()

tokui.modalTransitionStyle = .crossDissolve
self.present(tokui, animated: true, completion: nil)

You must use "PreparePages()" before "self.present"

Usage

Tokui is very simple.

Lighting items

A spotlite and message Label is positioned automatically.

"message" can include "\n" (line feed).

tokui.add(target: button , message:"You tapped here." , location: .above)
tokui.add(target: label , message:"Tokui is a comedian of the \n Japanese comedy duo Tutorial.")

PreparePages

tokui.PreparePages()

You must use "PreparePages()" before "self.present"

Raw call to TokuiViewController

let tokui = TokuiViewController(magnification: 1.2,
                                alpha: 0.5,
                                font: .systemFont(ofSize: 18.0),
                                displayDots: true,
                                pageControlPosition:nil)

Position

Enumeration 'MessagePosition' is defined as follow. (Default is auto.)

public enum MessagePosition
{
case above
case below
case right
case left
case auto
}

Contribute

We would love you for the contribution to Tokui, check the LICENSE file for more info.

Others

Yuiga Wada - WebSite Twitter - @YuigaWada

Distributed under the MIT license. See LICENSE for more information.

https://github.com/YuigaWada/Tokui