• Stars
    star
    333
  • Rank 126,578 (Top 3 %)
  • Language
    Swift
  • License
    MIT License
  • Created over 9 years ago
  • Updated almost 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An image download extension of the image view written in Swift for iOS, tvOS and macOS.

Moa, an image downloader written in Swift for iOS, tvOS and macOS

Carthage compatible CocoaPods Version Swift Package Manager compatible License Platform

Moa is an image download library written in Swift. It allows to download and show an image in an image view by setting its moa.url property.

imageView.moa.url = "https://bit.ly/moa_image"
  • Images are downloaded asynchronously.
  • Uses URLSession for networking and caching.
  • Allows to configure cache size and policy.
  • Can be used without an image view.
  • Provides closure properties for image manipulation and error handling.
  • Includes unit testing mode for faking network responses.
  • Contains logging capabilities for debugging network problems.

Moa hunting

"Lost, like the Moa is lost" - Maori proverb

'Hunting Moa' drawing by Joseph Smit (1836-1929). File source: Wikimedia Commons.

Setup

There are multiple ways you can add Moa to your Xcode project.

Add source (iOS 7+)

Simply add MoaDistrib.swift file into your Xcode project.

Setup with Carthage (iOS 8+)

Alternatively, add github "evgenyneu/moa" ~> 12.0 to your Cartfile and run carthage update.

Setup with CocoaPods (iOS 8+)

If you are using CocoaPods add this text to your Podfile and run pod install.

use_frameworks!
target 'Your target name'
pod 'moa', '~> 12.0'

Setup with Swift Package Manager

Legacy Swift versions

Setup a previous version of the library if you use an older version of Swift.

Usage

  1. Add import moa to your source code (unless you used the file setup method).

  2. Drag an Image View to your view in the storyboard. Create an outlet property for this image view in your view controller. Alternatively, instead of using the storyboard you can create a UIImageView object in code.

  3. Set moa.url property of the image view to start asynchronous image download. The image will be automatically displayed when download is finished.

imageView.moa.url = "https://bit.ly/moa_image"

Loading images from insecure HTTP hosts

If your image URLs are not https you will need to add an exception to the Info.plist file. This will allow the App Transport Security to load the images from insecure HTTP hosts.

Canceling download

Ongoing image download for the image view is automatically canceled when:

  1. Image view is deallocated.
  2. New image download is started: imageView.moa.url = ....

Call imageView.moa.cancel() to manually cancel the download.

Supply an error image

You can supply an error image that will be used if an error occurs during image download.

imageView.moa.errorImage = UIImage(named: "ImageNotFound.jpg")
imageView.moa.url = "https://bit.ly/moa_image"

Alternatively, one can supply a global error image that will be used for all failed image downloads.

Moa.errorImage = UIImage(named: "ImageNotFound.jpg")

Show a placeholder image

Here is how to show a placeholder image in the image view. The placeholder will be replaced by the image from the network when it arrives.

imageView.image = placeholderImage
imageView.moa.url = "https://bit.ly/moa_image"

Advanced features

Supplying completion closure

Assign a closure that will be called when image is received.

imageView.moa.onSuccess = { image in
  return image
}

imageView.moa.url = "https://bit.ly/moa_image"
  • The closure will be called after download finishes and before the image is assigned to the image view.
  • This is a good place to manipulate the image before it is shown.
  • The closure returns an image that will be shown in the image view. Return nil if you do not want the image to be shown.
  • The closure as called in the main queue. Use onSuccessAsync property instead if you need to do time consuming operations.
  • When errorImage is supplied and an error occurs the success closures are called.

Supplying error closure

imageView.moa.onError = { error, response in
  // Handle error
}

imageView.moa.url = "https://bit.ly/moa_image"
  • The closure is called in the main queue if image download fails. Use onErrorAsync property instead if you need to do time consuming operations.
  • See the "logging" section if you need to find out the type of the error.

Download an image without an image view

An instance of Moa class can also be used without an image view. A strong reference to Moa instance needs to be kept.

let moa = Moa()
moa.onSuccess = { image in
  // image is loaded
  return image
}
moa.url = "https://bit.ly/moa_image"

Clearing HTTP session

The following method calls finishTasksAndInvalidate on the current URLSession object. A new session object will be created for future image downloads.

MoaHttpSession.clearSession()

You may never need to call this method in your app. I needed to call it periodically to workaround a strange URLSession bug which you may not encounter.

Image caching

Use the Moa.settings.cache to change caching settings. For more information please refer to the moa image caching manual.

// By default images are cached according to their response HTTP headers.
Moa.settings.cache.requestCachePolicy = .useProtocolCachePolicy

// Always cache images locally regardless of their response HTTP headers
Moa.settings.cache.requestCachePolicy = .returnCacheDataElseLoad

// Change the name of the cache directory. Useful for sharing cache with the rest of the app.
Moa.settings.cache.diskPath = "MyAppSharedCache"

Settings

Use Moa.settings property to change moa image download settings.

// Set the maximum number of simultaneous image downloads. Default: 4.
Moa.settings.maximumSimultaneousDownloads = 5

// Change timeout for image requests. Default: 10.
Moa.settings.requestTimeoutSeconds = 20

Logging

You can use the moa logger to see how/when the images are loaded or debug a network problem. One can use a pre-made MoaConsoleLogger function to see the log messages in the Xcode console or write a custom logger. See the logging manual for more information.

// Log to console
Moa.logger = MoaConsoleLogger

// Load an image
imageView.moa.url = "https://bit.ly/moa_image"

// Attempt to load a missing image
imageView.moa.url = "https://bit.ly/moa_image_missing.jpg"

Logging to console with moa

Unit testing

Sometimes it is useful to prevent code from making real HTTP requests. Moa includes MoaSimulator class for testing image downloads and faking network responses. See unit test manual for more information.

// Autorespond with the given image to all image requests
MoaSimulator.autorespondWithImage("www.site.com", image: UIImage(named: "35px.jpg")!)

Demo app

The demo iOS app shows how to load images in a collection view with Moa.

Moa image downloader demo iOS app

Alternative solutions

Here is the list of other image download libraries for Swift.

Credits

License

Moa is released under the MIT License.

Feedback is welcome

If you notice any issue, got stuck or just want to chat feel free to create an issue. I will be happy to help you.

โ€ขแดฅโ€ข

This project is dedicated to the moa, species of flightless birds that lived in New Zealand and became extinct in 15th century.

More Repositories

1

keychain-swift

Helper functions for saving text in Keychain securely for iOS, OS X, tvOS and watchOS.
Swift
2,577
star
2

Cosmos

A star rating control for iOS/tvOS written in Swift
Swift
2,119
star
3

Dodo

A message bar for iOS written in Swift.
Swift
875
star
4

SigmaSwiftStatistics

A collection of functions for statistical calculation written in Swift.
Swift
682
star
5

js-evaluator-for-android

A library for running JavaScript in Android apps.
JavaScript
476
star
6

swift-badge

A badge view for iOS/tvOS written in Swift
Swift
390
star
7

Auk

An image slideshow for iOS written in Swift.
Swift
277
star
8

center-vfl

Centering a view in a super view with Visual Format Language using Auto Layout in iOS/Swift
Swift
227
star
9

ios-imagescroll-swift

iOS demo of using image view inside a scroll view with auto layout in Swift
Swift
128
star
10

UnderKeyboard

An iOS libary for moving content from under the keyboard.
Swift
128
star
11

SpringAnimationCALayer

A helper function for animating CALayer with spring effect in Swift
Swift
117
star
12

Cephalopod

A sound fader for AVAudioPlayer written in Swift for iOS, tvOS and macOS.
Swift
112
star
13

bubble-button-animation-ios-swift

Demo iOS app showing button animation
Swift
66
star
14

bounce-button-animation-android

A demo Android app that shows how to animate a button with spring/bounce effect.
Java
61
star
15

ios-imagescroll

iOS: example of using image view inside a scroll view with auto layout, written in Obective-C.
Objective-C
59
star
16

angular-markdown-preview

AngularJS module for markdown textarea with live HTML preview.
JavaScript
35
star
17

ios-javascriptcore-demo

iOS demo: running javascript function from ObjectiveC using JavaScriptCore framework
Objective-C
32
star
18

Glyptodon

A 'no content' message overlay for iOS written in Swift.
Swift
31
star
19

Scrollable

An iOS control that makes content scroll vertically.
Swift
20
star
20

aes-crypto-web

Web app for encrypting text messages http://aescrypto.com
JavaScript
20
star
21

JsonSwiftson

A JSON parser with concise API written in Swift.
Swift
14
star
22

aes-crypto-android

Android app for encrypting text messages http://aescrypto.com
JavaScript
12
star
23

two_galaxies

A web simulation of two interacting galaxies
JavaScript
10
star
24

walk-to-circle-ios

An iOS app for those who like walking
Swift
9
star
25

trigonometric_identities_latex

Trigonometric identities in LaTeX format
TeX
8
star
26

greeter-android

Sample code for "Testing activity in Android Studio" tutorial.
Java
6
star
27

aes-text-encryption-ios

iOS app for encrypting text messages http://aescrypto.com
JavaScript
5
star
28

sharing-keychain-demo

A demo iOS app showing how to access a shared keychain item
Swift
4
star
29

ios-core-location-battery-meter

iOS demo app for measuring power consumption of location services
Swift
4
star
30

core-location-tester-ios

Demo iOS app for testing Core Location accuracy
Swift
3
star
31

SneakPeekScroll

An iOS demo app showing a scroll view with images and lets you see a portion of the next and previous images
Swift
3
star
32

evgenii.com

My personal web site at http://evgenii.com
JavaScript
3
star
33

FortranFromPython

An example of running a Fortran code from Python
Python
3
star
34

siba

Simple backup and restore utility
Ruby
2
star
35

tarpan

Python functions for analysing cmdspanpy output
Python
2
star
36

image_compressor_c

An image compressor program written in C that uses singular value expansion
C
2
star
37

docker-rails-fig-sample

A sample Rails/Postgres app that shows how to use Docker and Fig
Ruby
2
star
38

oct_viewer

Demo of the OCT viewer
JavaScript
1
star
39

siba-destination-ftp

FTP destination for SIBA backup and restore utility.
Ruby
1
star
40

watch-kit-app-demo

Demo WatchKit app from the video tutorial.
Swift
1
star
41

walk-to-circle-android

An Android app for those who like walking
Java
1
star
42

distance_from_parallax

A Python program that plots distances measured from simulated parallaxes.
Python
1
star
43

covid19

A naive Stan model of confirmed COVID-19 cases that uses logistic function.
Python
1
star
44

siba-source-mysql

Backup and restore MySQL database. This is an extension to SIBA utility.
Ruby
1
star
45

ai_teaches_me_ml

This is my logbook from my interactive lessons where ChatGPT teaches me ML
Jupyter Notebook
1
star
46

siba-destination-aws-s3

Backup to Amazon S3 cloud storage. This is an extension to SIBA backup and restore utility.
Ruby
1
star
47

SixBouncingButtons

An example of creating six buttons with bounce effect in Android
Java
1
star
48

siba-source-mongo-db

MongoDb backup and restore plugin for SIBA
Ruby
1
star
49

ASP3162

Codes for ASP3162 labs
Fortran
1
star
50

WatchKitParentAppBenchmark

A demo app showing how to communicate between watchOS and iOS using the sendMessage method of watch connectivity framework.
Swift
1
star