Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jrsaruo/mediaviewer
A comfortable media viewer like the iOS standard.
https://github.com/jrsaruo/mediaviewer
image-viewer ios photo-browser photo-viewer
Last synced: about 1 month ago
JSON representation
A comfortable media viewer like the iOS standard.
- Host: GitHub
- URL: https://github.com/jrsaruo/mediaviewer
- Owner: jrsaruo
- License: mit
- Created: 2023-02-24T19:15:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-24T07:44:10.000Z (9 months ago)
- Last Synced: 2024-04-24T14:58:23.367Z (8 months ago)
- Topics: image-viewer, ios, photo-browser, photo-viewer
- Language: Swift
- Homepage:
- Size: 540 KB
- Stars: 35
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MediaViewer
A comfortable media viewer like the iOS standard.
 
## Requirements
- iOS 16+
- Swift 5.8+
## How to use
1. Make a type that conforms to `MediaViewerDataSource` protocol.
```swift
extension YourViewController: MediaViewerDataSource {
// You can specify any type that conforms to `Hashable`.
typealias MediaIdentifier = UIImage
// var images: [UIImage]
func mediaIdentifiers(
for mediaViewer: MediaViewerViewController
) -> [MediaIdentifier] {
images
}
func mediaViewer(
_ mediaViewer: MediaViewerViewController,
mediaWith mediaIdentifier: MediaIdentifier // UIImage
) -> Media {
.sync(mediaIdentifier)
// Or you can fetch media asynchronously by `.async { ... }`
}
func mediaViewer(
_ mediaViewer: MediaViewerViewController,
transitionSourceViewForMediaWith mediaIdentifier: MediaIdentifier
) -> UIView? {
// Return a view that is animated when the viewer opens or closes.
imageView(for: mediaIdentifier)
}
}
```
2. Create a `MediaViewerViewController` instance and push it. That's all! :tada:
```swift
let mediaViewer = MediaViewerViewController(opening: image, dataSource: self)
navigationController?.delegate = mediaViewer
navigationController?.pushViewController(mediaViewer, animated: true)
```
See demo for more detailed usage.
## Using MediaViewer in your project
To use the `MediaViewer` library in a SwiftPM project, add the following line to the dependencies in your `Package.swift` file:
```swift
.package(url: "https://github.com/jrsaruo/MediaViewer", from: "0.1.3"),
```
and add `MediaViewer` as a dependency for your target:
```swift
.target(name: "", dependencies: [
.product(name: "MediaViewer", package: "MediaViewer"),
// other dependencies
]),
```
Finally, add `import MediaViewer` in your source code.