Collection of iOS drop-in components to visualize progress
Objective-C Ruby Shell
Latest commit 661a46a Jul 14, 2016 @mrackwitz committed on GitHub Merge pull request #124 from kylebshr/master
Fix window crash on iOS 8

README.md

MRProgress

Twitter: @mrackwitz License: MIT CocoaPods Travis

MRProgress is a collection of drop-in components that display a dimmed overlay with a blurred box view with an indicator and/or labels while work is being done in a background thread.

  • Component oriented: You don't have to use all components or MRProgressOverlayView. You can use just the custom activity indicators or progress views.
  • Configurable: All components implement tintColor.
  • Customizable: You can replace the given blur implementation and hook into your own you are maybe already using in other places of your app. Or simply throw in an UIToolbar's layer, if you prefer Apple's implementation. (Current blur implementation is as given by sample code of WWDC 2013.)
  • Reusable: The code is fragmented in small reusable pieces.
  • Well documented: You can install and open Appledoc documentation.
  • Integrated: It offers an integration into AFNetworking.
  • Accessible: It provides labels, traits and events for UIAccessibility.

Components

The components used in MRProgressOverlayView could be used seperately. The provided Example app demonstrates how they can be used.

MRProgressOverlayView

  • Supports different modes
  • Animated show and hide
  • Blured background
  • With UIMotionEffects for tilting like UIAlertView
  • Supports multi-line title label text

MRCircularProgressView

  • Tint color can be changed
  • Circular progress view like in AppStore
  • Can display a stop button
  • Animated with CABasicAnimation
  • Percentage label change is animated over a NSTimer

MRNavigationBarProgressView

  • Display a progress view in a UINavigationController
  • Hooks UINavigationControllerDelegate and is automatically removed on push or pop
  • Can be used in UINavigationBar or UIToolbar

MRCheckmarkIconView and MRCrossIconView

  • Tint color can be changed
  • Scalable
  • Animatable
  • Backed by CAShapeLayer

MRActivityIndicatorView

  • Tint color can be changed
  • Same API as UIActivityIndicatorView
  • Can display a stop button
  • Animated with CABasicAnimation

Installation

CocoaPods

CocoaPods is the recommended way to add MRProgress to your project.

  1. Add a pod entry for MRProgress to your Podfile pod 'MRProgress'.
  2. Install the pod(s) by running pod install.
  3. Include MRProgress wherever you need it with #import <MRProgress/MRProgress.h> from Objective-C or import MRProgress from Swift.

Source files

  1. Download the latest code version or add the repository as a git submodule to your git-tracked project.
  2. Drag and drop the src directory from the archive in your project navigator. Make sure to select Copy items when asked if you extracted the code archive outside of your project.
  3. Include MRProgress wherever you need any component with #import "MRProgress.h" or include it in your bridging header to use it in Swift.

Static library

  1. Drag and drop MRProgress.xcodeproj in your project navigator.
  2. Select your target and go to the Build Phases tab. In the Link Binary With Libraries section select the add button. On the sheet find and add libMRProgress.a.
  3. Add Target MRProgress to your Target Dependencies list.
  4. Use import <MRProgress/MRProgress.h> from Objective-C or import MRProgress from Swift wherever you want to use the components.

CocoaPods - Subspecs

The library is cut in small subspecs, so that you can just depend on selected components. See the following dependency tree:

─┬─MRProgress/
 │
 ├───Blur
 │
 ├───ActivityIndicator
 │
 ├───Circular
 │
 ├───Icons
 │
 ├───NavigationBarProgress
 │
 ├─┬─Overlay
 │ ├───ActivityIndicator
 │ ├───Circular
 │ ├───Icons
 │ └───Blur
 |
 ├─┬─AFNetworking (optional)
 │ ├───ActivityIndicator
 │ ├───Circular
 │ ├───NavigationBarProgress
 │ └───Overlay
 |
 ├───MethodCopier (optional)
 │
 ├───MessageInterceptor (optional)
 │
 └───WeakProxy (optional)

The tree only list public specs, where you can rely on. You will see in the podspec and your Podfile.lock other subspecs, but you should NOT rely on these. Those are implementation details, which are subject to change and may been removed, even with a minor version update. Furthermore this tree doesn't show any cross-dependencies, which do exist.

Requirements

  • Xcode 5
  • iOS 7
  • ARC
  • Frameworks:
    • QuartzCore
    • CoreGraphics
    • Accelerate

Usage

Check out the provided demo app for many examples how you can use the components. Make sure you also see MRProgress documentation on Cocoadocs.

Basics

  1. Add the following import to the top of the file or to your Prefix header:

    // If used with CocoaPods
    #import "MRProgress.h"
    // If used as Framework
    #import <MRProgress/MRProgress.h>
  2. Use one the following ways to display the overlay:

    // Block whole window
    [MRProgressOverlayView showOverlayAddedTo:self.window animated:YES];
    // Block only the navigation controller
    [MRProgressOverlayView showOverlayAddedTo:self.navigationController.view animated:YES];
    // Block only the view
    [MRProgressOverlayView showOverlayAddedTo:self.view animated:YES];
    // Block a custom view
    [MRProgressOverlayView showOverlayAddedTo:self.imageView animated:YES];
  3. Simply dismiss after complete your task:

    // Dismiss
    [MRProgressOverlayView dismissOverlayForView:self.view animated:YES];

AFNetworking

MRProgress offers an integration into the network library AFNetworking.

  1. Include the following additional line into your Podfile:

    pod 'MRProgress/AFNetworking'
  2. Import the adequate category header for the component you want to use:

    #import <MRProgress/MRProgressOverlayView+AFNetworking.h>
  3. You can now just setup your task / operation as usual and use the category methods to bind to execution state and progress as shown below.

    // Init the progress overlay as usual
    MRProgressOverlayView *overlayView = [MRProgressOverlayView showOverlayAddedTo:self.view animated:YES];
    
    // The following line will do these things automatically:
    // * Set mode to determinate when a download or upload is in progress
    // * Set animated progress of the download or upload
    // * Show a checkmark or cross pane at the end of the progress
    [overlayView setModeAndProgressWithStateOfTask:task];
    
    // Allows the user to cancel the task by using the provided stop button.
    // If you use that, make sure that you handle the error code, which will be
    // delivered to the failure block of the task like shown below:
    //
    //    if ([error.domain isEqualToString:NSURLErrorDomain] && error.code == NSURLErrorCancelled) {
    //        NSLog(@"Task was cancelled by user.");
    //        return;
    //    }
    //
    [overlayView setStopBlockForTask:task];
    
    // If you use the activity indicator directly
    [self.activityIndicatorView setAnimatingWithStateOfTask:task];
    
    // If you use one of the progress views directly
    [self.circularProgressView setProgressWithUploadProgressOfTask:downloadTask animated:YES];   // for uploads
    [self.circularProgressView setProgressWithDownloadProgressOfTask:downloadTask animated:YES]; // for downloads
    [[MRNavigationBarProgressView progressViewForNavigationController:self.navigationController]
     setProgressWithDownloadProgressOfTask:downloadTask animated:YES];

    All methods are available for both 'NSURLSessionTask' and 'AFURLConnectionOperation' and their descendants. For further examples, make sure to also checkout the Example app.

Modes

Name (MRProgressOverlayView<...>) Screenshot Description
Indeterminate Progress is shown using a large round activity indicator view. (MRActivityIndicatorView) This is the default.
DeterminateCircular Progress is shown using a round, pie-chart like, progress view. (MRCircularProgressView)
DeterminateHorizontalBar Progress is shown using a horizontal progress bar. (UIProgressView)
IndeterminateSmall Shows primarily a label. Progress is shown using a small activity indicator. (MRActivityIndicatorView)
IndeterminateSmallDefault Shows primarily a label. Progress is shown using a small activity indicator. (UIActivityIndicatorView in UIActivityIndicatorViewStyleGray)
Checkmark Shows a checkmark. (MRCheckmarkIconView)
Cross Shows a cross. (MRCrossIconView)

Credits

MRProgress' API was inspired by MBProgressHUD project.

The acquarium image was stolen by Jag Cesar's blur implementation.

You can find me on Twitter @mrackwitz.

License

Copyright (c) 2013 Marius Rackwitz git@mariusrackwitz.de

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.