bmanish90/CoachKit

Features

• Highlights any UIView with a transparent cutout
• Displays a message bubble with a dismiss button
• Draws a directional curved arrow toward the highlighted element
• Supports four diagonal directions
• Chainable multi-step onboarding flows
• Supports iOS 15+

Requirements

• iOS 15.0+
• Swift 5.9+
• Xcode 15+

Installation

Swift Package Manager

In Xcode: File → Add Package Dependencies → paste the URL below:

https://github.com/yourusername/CoachKit.git

Or add it to your Package.swift:

dependencies: [
    .package(url: "https://github.com/yourusername/CoachKit.git", from: "1.0.0")
]

Usage

import CoachKit

class ViewController: UIViewController, CoachDelegate {

    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)

        let coach = CoachMarkView()
        coach.delegate = self
        coach.show(
            on: myButton,
            message: "Tap here to get started!",
            padding: 10,
            cornerRadius: 12,
            in: view,
            buttonTitle: "Next",
            direction: .rightUp
        )
    }

    func coachMarkDidDismiss(direction: CoachDirection) {
        // Show next step here
    }
}

Directions

| Direction | Position | |-----------|----------| | .leftUp | Message below, arrow points upper-left | | .rightUp | Message below, arrow points upper-right | | .leftDown | Message above, arrow points lower-left | | .rightDown | Message above, arrow points lower-right |

License

CoachKit is available under the MIT license.

---

Step 5 — Create `LICENSE`

MIT License

Copyright (c) 2025 Your Name

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Package Metadata

Repository: bmanish90/CoachKit

Stars: 0

Forks: 0

Open issues: 0

Default branch: main

Primary language: swift

README: README.md