Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bdbergeron/remoteimage
A drop-in alternative to SwiftUI's AsyncImage, with support for custom URLSessions, caching, and animated phase changes.
https://github.com/bdbergeron/remoteimage
ios swift swiftui
Last synced: 3 months ago
JSON representation
A drop-in alternative to SwiftUI's AsyncImage, with support for custom URLSessions, caching, and animated phase changes.
- Host: GitHub
- URL: https://github.com/bdbergeron/remoteimage
- Owner: bdbergeron
- License: mit
- Created: 2023-09-21T19:20:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-06T02:59:35.000Z (5 months ago)
- Last Synced: 2024-10-11T09:35:36.953Z (4 months ago)
- Topics: ios, swift, swiftui
- Language: Swift
- Homepage: https://bdbergeron.github.io/RemoteImage/documentation/remoteimage/
- Size: 7.47 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🖼️ RemoteImage
A drop-in alternative to SwiftUI's `AsyncImage`, with support for custom URLSessions, caching, and animated phase changes.
[](https://codecov.io/gh/bdbergeron/remoteimage)
[](https://www.codefactor.io/repository/github/bdbergeron/remoteimage)
## Getting Started
Add `RemoteImage` to your project via Swift Package Manager, and add `import RemoteImage` where you want to use it.
```swift
.package(url: "https://github.com/bdbergeron/RemoteImage", from: "1.0.0"),
```
## Usage
`RemoteImage`'s APIs have been designed to make it super easy to adopt in your app/project. In most cases, it's a simple drop-in replacement for SwiftUI's `AsyncImage`.
Check out the `RemoteImage Demos` app in the Xcode project to see some live exmaples.
### Simple Configuration
```swift
let imageURL: URL?
/// A simple `RemoteImage` view.
RemoteImage(url: imageURL)
/// A simple `RemoteImage` view with modifier closure.
RemoteImage(url: imageURL) {
$0.resizable().scaledToFit()
}
/// A `RemoteImage` view with a custom placeholder view.
RemoteImage(url: imageURL) {
$0.resizable().scaledToFit()
} placeholder: {
ProgressView()
}
/// A `RemoteImage` view with custom placeholder and failure views.
RemoteImage(url: imageURL) {
$0.resizable().scaledToFit()
} placeholder: {
ProgressView()
} failure: { error in
ZStack {
Color.yellow.opacity(0.3)
Text("Image could not be loaded.")
.font(.caption)
.foregroundStyle(.secondary)
}
}
```
### Advanced Configuration
```swift
let imageURL: URL?
let urlSession = URLSession(configuration: .ephemeral)
let imageCache = URLCache(memoryCapacity: 10_000_000, diskCapacity: 0)
/// Image loaded with a custom `URLSession` and using a custom phase transition animation.
RemoteImage(
url: imageURL,
urlSession: urlSession,
configuration: RemoteImageConfiguration(
transaction: Transaction(
animation: .spring(duration: 1.0).delay(0.5))))
{
$0.resizable().scaledToFit()
}
/// Image loaded from a custom cache. If the image is not yet cached, a new `URLSession`
/// will be constructed using the `URLSessionConfiguration.default` configuration
/// and the provided cache instance.
RemoteImage(url: imageURL, cache: imageCache) {
$0.resizable().scaledToFit()
} placeholder: {
ZStack {
Color.black.opacity(0.05)
ProgressView()
}
}
```