{"id":20756957,"url":"https://github.com/saeid/swiftyoverlay","last_synced_at":"2025-04-28T20:40:25.952Z","repository":{"id":28244624,"uuid":"117715901","full_name":"saeid/SwiftyOverlay","owner":"saeid","description":"Show overlay and info on app components","archived":false,"fork":false,"pushed_at":"2022-09-02T18:11:12.000Z","size":77,"stargazers_count":81,"open_issues_count":4,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-22T08:46:16.623Z","etag":null,"topics":["guide","instructions","ios","overlay","showcase","swift","tour"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saeid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-16T17:21:06.000Z","updated_at":"2023-09-08T17:35:18.000Z","dependencies_parsed_at":"2022-08-25T21:10:39.936Z","dependency_job_id":null,"html_url":"https://github.com/saeid/SwiftyOverlay","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saeid%2FSwiftyOverlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saeid%2FSwiftyOverlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saeid%2FSwiftyOverlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saeid%2FSwiftyOverlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saeid","download_url":"https://codeload.github.com/saeid/SwiftyOverlay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251385271,"owners_count":21581186,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["guide","instructions","ios","overlay","showcase","swift","tour"],"created_at":"2024-11-17T09:36:07.221Z","updated_at":"2025-04-28T20:40:25.934Z","avatar_url":"https://github.com/saeid.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SwiftyOverlay\nA component to show instructions and info on UI at run time with easy to setup and customizable API.\n\nSupported Components are : `UITabbarItem`, `TableView`, `TabbarView`, all `UIView` controls and components!\n\nFor demo project check [this repo](https://github.com/saeid/SwiftyGuideOverlay)\n\n![2](https://cloud.githubusercontent.com/assets/9967486/21859393/a6fbe282-d841-11e6-9271-e0e9e9c6bb6c.gif)\n![1](https://cloud.githubusercontent.com/assets/9967486/21859399/ac3822a6-d841-11e6-9272-64c553630e1c.gif)\n\n\n## Requirements\n- Xcode 9+\n- Swift 4+\n- iOS 9+\n\n\n## Installation\n\n## Swift Package Manager\n\n```swift\n.package(url: \"https://github.com/saeid/SwiftyOverlay.git\", from: \"1.1.14\")\n```\n\n## Cocoapods\n\n```\nsource 'https://github.com/CocoaPods/Specs.git'\nplatform :ios, '9.0'\nuse_frameworks!\n\ntarget '\u003cYour Target Name\u003e' do\npod 'SwiftyOverlay'\nend\n```\n    pod update \n    pod install\n\n## Usage\n\nInherit `SkipOverlayDelegate`\n```swift\nclass ViewController: UIViewController, SkipOverlayDelegate\n```\n\nCreate an instance of GDOverlay\n```swift\nvar overlay: GDOverlay = GDOverlay()\n```\n\nSet delegate\n```swift\noverlay.delegate = self\n```\n\nSet properties\n```swift \noverlay.arrowColor = UIColor.red\noverlay.arrowWidth = 2.0\noverlay.lineType = LineType.line_bubble\n\n...\n\n// Full properties list can be found on sample project\n\n```\n\nNow call Overlay View Skip function to show!\n```swift\nonSkipSignal()\n```\n\nOverride `onSkipSignal` function\n```swift\nfunc onSkipSignal(){\n    /// Add an attributed string over the screen\n    overlay.drawOverlay(desc: NSMutableAttributedString)\n\n    /// TableView\n    overlay.drawOverlay(to: self.tableView, section: 0, row: 0, desc: \"Description ...\")\n    \n    /// UIBarButtonItem\n    overlay.drawOverlay(to: barButtonItem, desc: \"Description ...\")\n\n    /// Any other views\n    overlay.drawOverlay(to: self.someView, desc: \"Description ...\", isCircle: true)\n    \n    /// TabBar Items\n    overlay.drawOverlay(to: self.tabbarView, item: 0, desc: \"Description ...\")\n    \n    /// For StackViews, Eg. first view of stackview\n    let targetView = stackView.arrangedSubviews[0]\n    o.drawOverlay(to: targetView, desc: \"Description ...\", isCircle: true)\n}\n```\n\n## Licence\nSwiftyHelpOverlay is available under the MIT license. See the [LICENSE.txt](https://github.com/SaeidBsn/SwiftyGuideOverlay/blob/master/Licence.txt) file for more info.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaeid%2Fswiftyoverlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaeid%2Fswiftyoverlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaeid%2Fswiftyoverlay/lists"}