Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saeid/SwiftyOverlay
Show overlay and info on app components
https://github.com/saeid/SwiftyOverlay
guide instructions ios overlay showcase swift tour
Last synced: 3 months ago
JSON representation
Show overlay and info on app components
- Host: GitHub
- URL: https://github.com/saeid/SwiftyOverlay
- Owner: saeid
- License: mit
- Created: 2018-01-16T17:21:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-02T18:11:12.000Z (about 2 years ago)
- Last Synced: 2024-08-05T00:01:32.075Z (3 months ago)
- Topics: guide, instructions, ios, overlay, showcase, swift, tour
- Language: Swift
- Homepage:
- Size: 75.2 KB
- Stars: 81
- Watchers: 4
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ios - SwiftyOverlay - Easy and quick way to show intro / instructions over app UI without any additional images in real-time! (Walkthrough / Intro / Tutorial / Web View)
- awesome-ios-star - SwiftyOverlay - Easy and quick way to show intro / instructions over app UI without any additional images in real-time! (Walkthrough / Intro / Tutorial / Web View)
README
# SwiftyOverlay
A component to show instructions and info on UI at run time with easy to setup and customizable API.
Supported Components are : `UITabbarItem`, `TableView`, `TabbarView`, all `UIView` controls and components!
For demo project check [this repo](https://github.com/saeid/SwiftyGuideOverlay)
## Requirements
- Xcode 9+
- Swift 4+
- iOS 9+
## Installation
## Swift Package Manager
```swift
.package(url: "https://github.com/saeid/SwiftyOverlay.git", from: "1.1.14")
```
## Cocoapods
```
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '' do
pod 'SwiftyOverlay'
end
```
pod update
pod install
## Usage
Inherit `SkipOverlayDelegate`
```swift
class ViewController: UIViewController, SkipOverlayDelegate
```
Create an instance of GDOverlay
```swift
var overlay: GDOverlay = GDOverlay()
```
Set delegate
```swift
overlay.delegate = self
```
Set properties
```swift
overlay.arrowColor = UIColor.red
overlay.arrowWidth = 2.0
overlay.lineType = LineType.line_bubble
...
// Full properties list can be found on sample project
```
Now call Overlay View Skip function to show!
```swift
onSkipSignal()
```
Override `onSkipSignal` function
```swift
func onSkipSignal(){
/// Add an attributed string over the screen
overlay.drawOverlay(desc: NSMutableAttributedString)
/// TableView
overlay.drawOverlay(to: self.tableView, section: 0, row: 0, desc: "Description ...")
/// UIBarButtonItem
overlay.drawOverlay(to: barButtonItem, desc: "Description ...")
/// Any other views
overlay.drawOverlay(to: self.someView, desc: "Description ...", isCircle: true)
/// TabBar Items
overlay.drawOverlay(to: self.tabbarView, item: 0, desc: "Description ...")
/// For StackViews, Eg. first view of stackview
let targetView = stackView.arrangedSubviews[0]
o.drawOverlay(to: targetView, desc: "Description ...", isCircle: true)
}
```
## Licence
SwiftyHelpOverlay is available under the MIT license. See the [LICENSE.txt](https://github.com/SaeidBsn/SwiftyGuideOverlay/blob/master/Licence.txt) file for more info.