Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yhkaplan/moonwalker
A simple iOS Walkthrough framework
https://github.com/yhkaplan/moonwalker
Last synced: about 1 month ago
JSON representation
A simple iOS Walkthrough framework
- Host: GitHub
- URL: https://github.com/yhkaplan/moonwalker
- Owner: yhkaplan
- License: mit
- Created: 2018-06-20T10:28:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-09T09:14:27.000Z (over 4 years ago)
- Last Synced: 2024-12-06T05:46:55.958Z (about 2 months ago)
- Language: Swift
- Size: 299 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MoonWalker
By [yhkaplan](http://[email protected]).
## Introduction
MoonWalker is an easy to use walkthrough library.
## Usage
```swift
import MoonWalker
// ...
```
## Requirements
* iOS 11.0+
* Xcode 11.0+
## Getting involved
* If you **want to contribute** please feel free to **submit pull requests**.
* If you **have a feature request** please **open an issue**.
Before contribute check the [CONTRIBUTING](https://github.com/[email protected]/MoonWalker/blob/master/CONTRIBUTING.md) file for more info.
## Usage
```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
let views = [0, 1, 2].map { index -> MWChildViewModel in
let upperLabel = MWUpperLabelSettings(text: "Screen \(index)")
let image = UIImage(named: "screen\(index)")
let backgroundImage = MWBackgroundImageSettings(image: image)
return MWChildViewModel(upperLabel: upperLabel, backgroundImage: backgroundImage)
}
let creator = MWParentViewCreator(childViews: views)
let walkthroughVC = creator.getParentViewController()
window!.rootViewController = walkthroughVC
window!.makeKeyAndVisible()
return true
}
```
## Examples
Follow these 3 steps to run Example project: clone MoonWalker repository, open MoonWalker workspace and run the *Example* project.
## Installation
* If you are having issues installing, then it may be due to an old version of Sourcery that is incompatible with the latest file format. To fix this, please a). upgrade or b) uninstall sourcery.
#### Swift Package Manager
Add via Xcode in the [usual way](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)
### CocoaPods
[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects.
To install MoonWalker, simply add the following line to your Podfile:
```ruby
pod 'MoonWalker', '~> 1.0'
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a simple, decentralized dependency manager for Cocoa.
To install MoonWalker, simply add the following line to your Cartfile:
```ruby
github "yhkaplan/MoonWalker" ~> 1.0
```
## Author
* [yhkaplan](https://github.com/[email protected]) ([@[email protected]](https://twitter.com/[email protected]))
# Changelog
See [CHANGELOG](CHANGELOG.md).