Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huemae/SuggestionsKit
SuggestionsKit
https://github.com/huemae/SuggestionsKit
Last synced: about 1 month ago
JSON representation
SuggestionsKit
- Host: GitHub
- URL: https://github.com/huemae/SuggestionsKit
- Owner: huemae
- License: mit
- Created: 2020-04-23T14:34:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-16T12:31:31.000Z (over 3 years ago)
- Last Synced: 2024-10-01T22:01:15.243Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 2.44 MB
- Stars: 69
- Watchers: 6
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-swift - SuggestionsKit - Library for educating users about features in app. (Libs / UI)
- awesome-swift - SuggestionsKit - SuggestionsKit ` 📝 11 days ago` (UI [🔝](#readme))
- awesome-swift - SuggestionsKit - Library for educating users about features in app. (Libs / UI)
README
# SuggestionsKit
[](https://travis-ci.org/huemae/SuggestionsKit)
[](https://cocoapods.org/pods/SuggestionsKit)
[](https://cocoapods.org/pods/SuggestionsKit)
[](https://cocoapods.org/pods/SuggestionsKit)
## Description
SuggestionsKit is a framework for iOS that was created in order to provide developers with the opportunity to educate users on various features of applications.
## Requirements
* Xcode 11 / Swift 5+
* iOS 9.0+
## Features
* Easy to use in project
* Nice looking animations
* Supports device rotations
* Supports navigation items and tab bar items
* Supports view resizing and changing of position via observation
* Customizable settings
## Usage
Import ```SuggestionsKit```
```swift
import SuggestionsKit
```
Next you need to create one or more suggestions. Simple init method takes ```UIVIew```, ```CGRect ``` , ```String ``` and ```NSAttributedString ``` as arguments.
```swift
let frameSuggestion2 = Suggestion(frame: .init(x: 100, y: 100, width: 200, height: 200), attributedText: attributedString)
```
If you pass ```attributedText``` then ```text``` is ignored and if you pass ```view``` then ```frame``` ignored too.
If you pass ```attributedText``` then ```textColor``` and ```font``` from ```SuggestionsConfig.TextConfig``` is ignored
After you just call ```apply``` method of ```SuggestionManager``` class
```swift
SuggestionsManager.apply(suggestions)
```
Optionaly you could call ```configre``` method to setup suggestions which will presented to user. If this method will not be called then default configuration will be used
```swift
SuggestionsManager.apply(suggestions)
.configre(config)
```
And you are done! Next step is just call ```startShowing``` method to start showing suggestions.
```swift
SuggestionsManager.apply(suggestions)
.configre(config)
.startShowing()
```
If suggestions ended whole view will dissapear automaticaly.
If you want to stop process manualy simply call ```stopShowing``` method of ```SuggestionManager``` class
```swift
SuggestionsManager.stopShowing()
```
If you want to be notified when suggestion come to an end just call ```completion``` method of ```SuggestionManager``` that takes void closure as an argument
```swift
SuggestionsManager.apply(suggestions)
.configre(config)
.startShowing()
.completion {
print("suggestions finished")
}
```
Additionally you could create suggestion from ```tabBarController.tabBar``` or ```navigationController.navigationBar``` with help of ```SuggestionsHelper``` class
```swift
let tabBarItems = SuggestionsHelper.findAllBarItems(in: tabBarController?.tabBar)
suggestions += tabBarItems.enumerated()
.map { Suggestion(view: $0.element, text: "Tab bar item \($0.offset)") }
let navItems = SuggestionsHelper.findAllBarItems(in: navigationController?.navigationBar)
let navSuggestions = navItems.enumerated()
.map { Suggestion(view: $0.element, text: $0.offset == 0 ? "back button" : "bar button item") }
suggestions += navSuggestions
```
Please keep in mind that this functionality is implemented using recursive search of visual elements and may be broken in future versions of iOS
This method does not use private properties for searching
## Example
To run the example project, clone the repo, open the ```SuggestionsKit.xcworkspace``` workspace, then select target ```SuggestionsKit-Example``` and you are ready to test the example
## Installation
### CocoaPods
SuggestionsKit is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'SuggestionsKit'
```
### Swift Package Manager
```swift
dependencies: [.package(url: "https://github.com/huemae/SuggestionsKit", Package.Dependency.Requirement.branch("master"))]
```
## Author
huemae
## License
SuggestionsKit is available under the MIT license. See the LICENSE file for more info.