Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-horizon/RoundCoachMark
The Swift library for showing the rounded coach marks (useful for onboarding or run-time help purposes)
https://github.com/digital-horizon/RoundCoachMark
coach-marks coachmark coachmarks onboarding swift-library
Last synced: 3 months ago
JSON representation
The Swift library for showing the rounded coach marks (useful for onboarding or run-time help purposes)
- Host: GitHub
- URL: https://github.com/digital-horizon/RoundCoachMark
- Owner: digital-horizon
- License: mit
- Created: 2017-12-13T12:41:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-29T08:00:15.000Z (over 4 years ago)
- Last Synced: 2024-04-25T07:41:44.642Z (7 months ago)
- Topics: coach-marks, coachmark, coachmarks, onboarding, swift-library
- Language: Swift
- Homepage:
- Size: 6.19 MB
- Stars: 69
- Watchers: 4
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cocoa - RoundCoachMark
README
# RoundCoachMark
[](/LICENSE)
[](http://cocoadocs.org/docsets/BadgeSwift)
**RoundCoachMark** is a small Swift library for showing animated focused on GUI element round-shaped overlays - coach marks - with text for onboarding or run-time help purposes.
**RoundCoachMark** supports customization. You can set colors, fonts and adjust dynamics.
**RoundCoachMark's** main feature is the mechanism of pre-registration of a coach mark - you register a mark when it is convenient to do (on appearence or configuration) and forget about it. Next time the CoachMarker starts it will find the mark and show it as appropriate. You can show marks for basic GUI elements like buttons, input fields, labels and icons independently of whether they are static or appearing, say, in a table view cell.
## Usage
There are two basic scenarios for coach marks.
### Simple scenario
The first one is illustrated by `SimpleCoachMarkerDemoVC` in demo project. In this scenario all GUI elements (controls) you want to show up are in the the same view controller, thus you can add them to the CoachMarker directly
A view controller class declarations:
```swift
@IBOutlet weak var gearButton: UIButton!
@IBOutlet weak var exitButton: UIButton!
private var coachMarker:CoachMarker?
```
In some setup method:
```swift
coachMarker = CoachMarker(in:self.view, infoPadding:20)
coachMarker!.addMark(title:"Gear up!", info:"Tap the icon to open Settings screen.",
control:gearButton)
coachMarker!.addMark(title:"Get out of here!", info:"Tap this to exit",
control:exitButton)
```
There are several methods to add (or register) a mark. Please, see the demo project to find all.
Finally in `viewDidAppear` to start right away or in help-button handler
```swift
coachMarker?.tapPlay(autoStart:true, completion:{print("tapPlay finished")})
// or
coachMarker?.autoPlay(delay:0.5, interval:1, completion:{print("autoPlay finished")})
```
Both play-methods show all added marks one after another then destroy the CoachMarker.
Alternatively you can avoid the CoachMarker destrruction with flag and reuse it later.
```swift
coachMarker?.tapPlay(autoStart:true, destroyWhenFinished:false, completion:{print("tapPlay finished")})
```
### Realistic scenario
The second scenario is more realistic. It is illustrated by `ComplexCoachMarkerDemoVC` in the demo project. Imagine your screen consists of several view controllers and hierarchy of views: root container controller (custom or system provided like navigation controller), embedded bars/menu controllers, a child content controller with table view and cells containing controls you whant to show up with the CoachMarker.
Apparently, you will want to create the CoarchMarker on root container controller level, but how to reach out the contlols from that level? Here is how.
Instead of adding a mark to the CoachMarker directly you pre-register it in some method which is guarantied to start before the CoachMarker created:
```swift
CoachMarker.registerMark(title:"Show modal view controller",
info:"A modal view controller brings his owm coach marks, so other marks are to be disabled. It's done by 'unregistering' active marks in viewWillDisappear of overlapped controllers.",
control:showmodalButton,
markTag:"scenario-2")
```
As you see you can use `markTag:` parameter to tag a mark and then it will only be shown by the CoachMarker tagged with the same tag. Thus you can have as many markers as you need. Alternatively, you can unregister marks.
Now you create the marker and start it as in the simple scenario.
```swift
coachMarker = CoachMarker(in:marksContainer, infoPadding:20, tag:"scenario-2")
...
coachMarker?.tapPlay(autoStart:true, destroyWhenFinished:false)
```
The play methods are not the only way to control showing of marks. You can construct your own logic of showing marks and implement it using the CoachMarker interface methods:
```swift
public func presentMark(_ index:Int, completion:@escaping ()->Void)
public func dismissMark(completion:@escaping ()->Void)
public func presentNextMark(completion:@escaping ()->Void)
```
## Installation
### Cocoapods
To integrate RoundCoachMark into your Xcode project using CocoaPods, specify it in your `Podfile`:
pod 'RoundCoachMark'
## License
**RoundCoachMark** is released under the [MIT License](LICENSE).