Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kean/Nuke

Image loading system
https://github.com/kean/Nuke

cache gif image progressive swift webp

Last synced: 4 days ago
JSON representation

Image loading system

Awesome Lists containing this project

README 

        






# Image Loading System












> *Serving Images Since 2015*



Load images from different sources and display them in your app using simple and flexible APIs. Take advantage of the powerful image processing capabilities and a robust caching system.



The framework is lean and compiles in under 2 seconds[¹](#footnote-1). It has an automated test suite 2x the codebase size, ensuring excellent reliability. Nuke is optimized for [performance](https://kean-docs.github.io/nuke/documentation/nuke/performance-guide), and its advanced architecture enables virtually unlimited possibilities for customization.



> **Memory and Disk Cache** · **Image Processing & Decompression** · **Request Coalescing & Priority** · **Prefetching** · **Resumable Downloads** · **Progressive JPEG** · **HEIF, WebP, SVG, GIF** · **SwiftUI** · **Async/Await**



## Sponsors



[**Lapse**](https://www.lapse.com): friends *not followers*.



Lapse Logo



Nuke is also supported by:



  

    

        

          Proxyman Logo

          
Proxyman


        

    

    

      

        Backspace Travel

        
Backspace Travel


      

    

  



## Installation



Nuke supports [Swift Package Manager](https://www.swift.org/package-manager/), which is the recommended option. If that doesn't work for you, you can use binary frameworks attached to the [releases](https://github.com/kean/Nuke/releases).



The package ships with four modules that you can install depending on your needs:



|Module|Description|

|--|--|

|[**Nuke**](https://kean-docs.github.io/nuke/documentation/nuke)|The lean core framework with `ImagePipeline`, `ImageRequest`, and more|

|[**NukeUI**](https://kean-docs.github.io/nukeui/documentation/nukeui/)|The UI components: `LazyImage` (SwiftUI) and `ImageView` (UIKit, AppKit)|

|[**NukeExtensions**](https://kean-docs.github.io/nukeextensions/documentation/nukeextensions/)|The extensions for `UIImageView` (UIKit, AppKit)|

|[**NukeVideo**](https://kean-docs.github.io/nukevideo/documentation/nukevideo/)|The components for decoding and playing short videos|



## Documentation



Nuke is easy to learn and use, thanks to its extensive documentation and a modern API. 



You can load images using `ImagePipeline` from the lean core [**Nuke**](https://kean-docs.github.io/nuke/documentation/nuke) module:



```swift

func loadImage() async throws {

    let imageTask = ImagePipeline.shared.imageTask(with: url)

    for await progress in imageTask.progress {

        // Update progress

    }

    imageView.image = try await imageTask.image

}

```



Or you can use the built-in UI components from the [**NukeUI**](https://kean-docs.github.io/nukeui/documentation/nukeui/) module:



```swift

struct ContentView: View {

    var body: some View {

        LazyImage(url: URL(string: "https://example.com/image.jpeg"))

    }

}

```



The [**Getting Started**](https://kean-docs.github.io/nuke/documentation/nuke/getting-started/) guide is the best place to start learning about these and many other APIs provided by the framework. Check out [**Nuke Demo**](https://github.com/kean/NukeDemo) for more usage examples.





Nuke Docs




## Extensions



The image pipeline is easy to customize and extend. Check out the following first-class extensions and packages built by the community.



|Name|Description|

|--|--|

|[**Alamofire Plugin**](https://github.com/kean/Nuke-Alamofire-Plugin)|Replace networking layer with [Alamofire](https://github.com/Alamofire/Alamofire)|

|[**NukeWebP**](https://github.com/makleso6/NukeWebP)| **Community**. [WebP](https://developers.google.com/speed/webp/) support, built by [Maxim Kolesnik](https://github.com/makleso6)|

|[**WebP Plugin**](https://github.com/ryokosuge/Nuke-WebP-Plugin)| **Community**. [WebP](https://developers.google.com/speed/webp/) support, built by [Ryo Kosuge](https://github.com/ryokosuge)|

|[**AVIF Plugin**](https://github.com/delneg/Nuke-AVIF-Plugin)| **Community**. [AVIF](https://caniuse.com/avif) support, built by [Denis](https://github.com/delneg)|

|[**RxNuke**](https://github.com/kean/RxNuke)|[RxSwift](https://github.com/ReactiveX/RxSwift) extensions for Nuke with examples|



> Looking for a way to log your network requests, including image requests? Check out [**Pulse**](https://github.com/kean/Pulse).



## Minimum Requirements



> Upgrading from the previous version? Use a [**Migration Guide**](https://github.com/kean/Nuke/tree/master/Documentation/Migrations).



| Nuke       | Date         | Swift       | Xcode      | Platforms                                     |

|------------|--------------|-------------|------------|-----------------------------------------------|

| Nuke 12.0  | Mar 4, 2023  | Swift 5.7   | Xcode 15.0 | iOS 13.0, watchOS 6.0, macOS 10.15, tvOS 13.0 |

| Nuke 11.0  | Jul 20, 2022 | Swift 5.6   | Xcode 13.3 | iOS 13.0, watchOS 6.0, macOS 10.15, tvOS 13.0 |

| Nuke 10.0  | Jun 1, 2021  | Swift 5.3   | Xcode 12.0 | iOS 11.0, watchOS 4.0, macOS 10.13, tvOS 11.0 |



> Starting with version 12.3, Nuke also ships with visionOS support (in beta)



## License



Nuke is available under the MIT license. See the LICENSE file for more info.



----



> ¹ Measured on MacBook Pro 14" 2021 (10-core M1 Pro)