Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gonzalezreal/networkimage
Asynchronous image loading in SwiftUI
https://github.com/gonzalezreal/networkimage
image-downloader load-image-asynchronously load-image-url swift swiftui
Last synced: 7 days ago
JSON representation
Asynchronous image loading in SwiftUI
- Host: GitHub
- URL: https://github.com/gonzalezreal/networkimage
- Owner: gonzalezreal
- License: mit
- Created: 2020-07-10T10:40:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-13T09:24:55.000Z (3 months ago)
- Last Synced: 2024-12-22T23:06:17.890Z (7 days ago)
- Topics: image-downloader, load-image-asynchronously, load-image-url, swift, swiftui
- Language: Swift
- Homepage:
- Size: 4.4 MB
- Stars: 74
- Watchers: 3
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# NetworkImage
[](https://github.com/gonzalezreal/NetworkImage/actions?query=workflow%3ACI)
[](https://swiftpackageindex.com/gonzalezreal/NetworkImage)
[](https://swiftpackageindex.com/gonzalezreal/NetworkImage)
NetworkImage is a Swift package that provides image downloading, caching, and displaying for your SwiftUI apps. It leverages the foundation `URLCache` and `NSCache`, providing persistent and in-memory caches.
Explore the [companion demo project](Demo) to discover its capabilities.
## Minimum requirements
You can use NetworkImage on the following platforms:
* macOS 11.0+
* iOS 14.0+
* tvOS 14.0+
* watchOS 7.0+
## Usage
A network image downloads and displays an image from a given URL; the download is asynchronous,
and the result is cached both in disk and memory.
The simplest way of creating a `NetworkImage` view is to pass the image URL to the `init(url:scale:)` initializer.
```swift
NetworkImage(url: URL(string: "https://picsum.photos/id/237/300/200"))
.frame(width: 300, height: 200)
```
To manipulate the loaded image, use the `content` parameter.
```swift
NetworkImage(url: URL(string: "https://picsum.photos/id/237/300/200")) { image in
image
.resizable()
.scaledToFill()
.blur(radius: 4)
}
.frame(width: 150, height: 150)
.clipped()
```
The view displays a standard placeholder that fills the available space until the image loads. You
can specify a custom placeholder by using the `placeholder` parameter.
```swift
NetworkImage(url: URL(string: "https://picsum.photos/id/237/300/200")) { image in
image
.resizable()
.scaledToFill()
} placeholder: {
ZStack {
Color.secondary.opacity(0.25)
Image(systemName: "photo.fill")
.imageScale(.large)
.blendMode(.overlay)
}
}
.frame(width: 150, height: 150)
.clipped()
```
To have more control over the image loading process, use the `init(url:scale:transaction:content)` initializer, which takes a `content` closure that receives a `NetworkImageState` to indicate the state of the loading operation.
```swift
NetworkImage(url: URL(string: "https://picsum.photos/id/237/300/200")) { state in
switch state {
case .empty:
ProgressView()
case .success(let image, let idealSize):
image
.resizable()
.scaledToFill()
case .failure:
Image(systemName: "photo.fill")
.imageScale(.large)
.blendMode(.overlay)
}
}
.frame(width: 150, height: 150)
.background(Color.secondary.opacity(0.25))
.clipped()
```
## Installation
### Adding NetworkImage to a Swift package
To use NetworkImage in a Swift Package Manager project, add the following line to the dependencies in your `Package.swift` file:
```swift
.package(url: "https://github.com/gonzalezreal/NetworkImage", from: "6.0.0")
```
Include `"NetworkImage"` as a dependency for your executable target:
```swift
.target(name: "", dependencies: [
.product(name: "NetworkImage", package: "NetworkImage")
]),
```
Finally, add `import NetworkImage` to your source code.
### Adding NetworkImage to an Xcode project
1. From the **File** menu, select **Add Packages…**
1. Enter `https://github.com/gonzalezreal/NetworkImage` into the
*Search or Enter Package URL* search field
1. Link **NetworkImage** to your application target