https://github.com/alexaubry/AURASlideshow
Simple component for displaying slideshows
https://github.com/alexaubry/AURASlideshow
ios slideshow swift tutorial
Last synced: 6 months ago
JSON representation
Simple component for displaying slideshows
- Host: GitHub
- URL: https://github.com/alexaubry/AURASlideshow
- Owner: alexaubry
- License: mit
- Created: 2018-09-20T11:53:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-20T11:59:54.000Z (over 7 years ago)
- Last Synced: 2025-07-19T11:06:36.142Z (6 months ago)
- Topics: ios, slideshow, swift, tutorial
- Language: Swift
- Size: 889 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AURASlideshow
AURASlideshow provides an interface to display a sequence of images and associated text. Ideal for a tutorial inside an app. Suports swiping and Voice Over.
## Installation
You can install the library from:
### CocoaPods
Add this line in your `Podfile`:
~~~
pod 'AURASlideshow', '~> 1.0'
~~~
### Carthage
Add this line in your `Cartfile`:
~~~
github "alexaubry/AURASlideshow" ~> 1.0
~~~
## Usage
The contents of the slideshow is defined as an array of objects conforming to the `SlideshowItem` protocol. Each object provides an image and a description of the item.
The first step is to import the framework and define your data source:
~~~swift
import AURASlideshow
enum ColorSlideshow: String, SlideshowItem, CaseIterable {
case red = "Red"
case green = "Green"
case blue = "Blue"
var image: UIImage {
return UIImage(named: "Slideshow-\(rawValue)")
}
var localizedValue: String {
return rawValue
}
}
~~~
Then, create the view controller, wrap it inside a navigation controller, and present it from a view controller:
~~~swift
func presentSlideshow() {
let slideshow = SlideshowViewController(title: "Colors", items: ColorSlideshow.allCases)
let slideshowNavigation = UINavigationController(rootViewController: slideshow)
self.present(slideshowNavigation, animated: true, completion: nil)
}
~~~
## Contributing
Thank you for your interest in the project! Contributions are welcome and appreciated.
Make sure to read these guides before getting started:
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Contribution Guidelines](CONTRIBUTING.md)
You will need Xcode 10 and Swift 4.2 to build the library.
## Author
Written by Alexis Aubry. You can [find me on Twitter](https://twitter.com/_alexaubry).
## License
AURASlideshow is available under the MIT license. See the [LICENSE](LICENSE) file for more info.