Sources/Base/NVActivityIndicatorView.swift
//
// NVActivityIndicatorView.swift
// NVActivityIndicatorView
//
// The MIT License (MIT)
// Copyright (c) 2016 Vinh Nguyen
// 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.
//
#if canImport(UIKit)
import UIKit
/**
Enum of animation types used for activity indicator view.
- Blank: Blank animation.
- BallPulse: BallPulse animation.
- BallGridPulse: BallGridPulse animation.
- BallClipRotate: BallClipRotate animation.
- SquareSpin: SquareSpin animation.
- BallClipRotatePulse: BallClipRotatePulse animation.
- BallClipRotateMultiple: BallClipRotateMultiple animation.
- BallPulseRise: BallPulseRise animation.
- BallRotate: BallRotate animation.
- CubeTransition: CubeTransition animation.
- BallZigZag: BallZigZag animation.
- BallZigZagDeflect: BallZigZagDeflect animation.
- BallTrianglePath: BallTrianglePath animation.
- BallScale: BallScale animation.
- LineScale: LineScale animation.
- LineScaleParty: LineScaleParty animation.
- BallScaleMultiple: BallScaleMultiple animation.
- BallPulseSync: BallPulseSync animation.
- BallBeat: BallBeat animation.
- BallDoubleBounce: BallDoubleBounce animation.
- LineScalePulseOut: LineScalePulseOut animation.
- LineScalePulseOutRapid: LineScalePulseOutRapid animation.
- BallScaleRipple: BallScaleRipple animation.
- BallScaleRippleMultiple: BallScaleRippleMultiple animation.
- BallSpinFadeLoader: BallSpinFadeLoader animation.
- LineSpinFadeLoader: LineSpinFadeLoader animation.
- TriangleSkewSpin: TriangleSkewSpin animation.
- Pacman: Pacman animation.
- BallGridBeat: BallGridBeat animation.
- SemiCircleSpin: SemiCircleSpin animation.
- BallRotateChase: BallRotateChase animation.
- Orbit: Orbit animation.
- AudioEqualizer: AudioEqualizer animation.
- CircleStrokeSpin: CircleStrokeSpin animation.
*/
public enum NVActivityIndicatorType: CaseIterable {
/**
Blank.
- returns: Instance of NVActivityIndicatorAnimationBlank.
*/
case blank
/**
BallPulse.
- returns: Instance of NVActivityIndicatorAnimationBallPulse.
*/
case ballPulse
/**
BallGridPulse.
- returns: Instance of NVActivityIndicatorAnimationBallGridPulse.
*/
case ballGridPulse
/**
BallClipRotate.
- returns: Instance of NVActivityIndicatorAnimationBallClipRotate.
*/
case ballClipRotate
/**
SquareSpin.
- returns: Instance of NVActivityIndicatorAnimationSquareSpin.
*/
case squareSpin
/**
BallClipRotatePulse.
- returns: Instance of NVActivityIndicatorAnimationBallClipRotatePulse.
*/
case ballClipRotatePulse
/**
BallClipRotateMultiple.
- returns: Instance of NVActivityIndicatorAnimationBallClipRotateMultiple.
*/
case ballClipRotateMultiple
/**
BallPulseRise.
- returns: Instance of NVActivityIndicatorAnimationBallPulseRise.
*/
case ballPulseRise
/**
BallRotate.
- returns: Instance of NVActivityIndicatorAnimationBallRotate.
*/
case ballRotate
/**
CubeTransition.
- returns: Instance of NVActivityIndicatorAnimationCubeTransition.
*/
case cubeTransition
/**
BallZigZag.
- returns: Instance of NVActivityIndicatorAnimationBallZigZag.
*/
case ballZigZag
/**
BallZigZagDeflect
- returns: Instance of NVActivityIndicatorAnimationBallZigZagDeflect
*/
case ballZigZagDeflect
/**
BallTrianglePath.
- returns: Instance of NVActivityIndicatorAnimationBallTrianglePath.
*/
case ballTrianglePath
/**
BallScale.
- returns: Instance of NVActivityIndicatorAnimationBallScale.
*/
case ballScale
/**
LineScale.
- returns: Instance of NVActivityIndicatorAnimationLineScale.
*/
case lineScale
/**
LineScaleParty.
- returns: Instance of NVActivityIndicatorAnimationLineScaleParty.
*/
case lineScaleParty
/**
BallScaleMultiple.
- returns: Instance of NVActivityIndicatorAnimationBallScaleMultiple.
*/
case ballScaleMultiple
/**
BallPulseSync.
- returns: Instance of NVActivityIndicatorAnimationBallPulseSync.
*/
case ballPulseSync
/**
BallBeat.
- returns: Instance of NVActivityIndicatorAnimationBallBeat.
*/
case ballBeat
/**
BallDoubleBounce.
- returns: Instance of NVActivityIndicatorAnimationBallDoubleBounce.
*/
case ballDoubleBounce
/**
LineScalePulseOut.
- returns: Instance of NVActivityIndicatorAnimationLineScalePulseOut.
*/
case lineScalePulseOut
/**
LineScalePulseOutRapid.
- returns: Instance of NVActivityIndicatorAnimationLineScalePulseOutRapid.
*/
case lineScalePulseOutRapid
/**
BallScaleRipple.
- returns: Instance of NVActivityIndicatorAnimationBallScaleRipple.
*/
case ballScaleRipple
/**
BallScaleRippleMultiple.
- returns: Instance of NVActivityIndicatorAnimationBallScaleRippleMultiple.
*/
case ballScaleRippleMultiple
/**
BallSpinFadeLoader.
- returns: Instance of NVActivityIndicatorAnimationBallSpinFadeLoader.
*/
case ballSpinFadeLoader
/**
LineSpinFadeLoader.
- returns: Instance of NVActivityIndicatorAnimationLineSpinFadeLoader.
*/
case lineSpinFadeLoader
/**
TriangleSkewSpin.
- returns: Instance of NVActivityIndicatorAnimationTriangleSkewSpin.
*/
case triangleSkewSpin
/**
Pacman.
- returns: Instance of NVActivityIndicatorAnimationPacman.
*/
case pacman
/**
BallGridBeat.
- returns: Instance of NVActivityIndicatorAnimationBallGridBeat.
*/
case ballGridBeat
/**
SemiCircleSpin.
- returns: Instance of NVActivityIndicatorAnimationSemiCircleSpin.
*/
case semiCircleSpin
/**
BallRotateChase.
- returns: Instance of NVActivityIndicatorAnimationBallRotateChase.
*/
case ballRotateChase
/**
Orbit.
- returns: Instance of NVActivityIndicatorAnimationOrbit.
*/
case orbit
/**
AudioEqualizer.
- returns: Instance of NVActivityIndicatorAnimationAudioEqualizer.
*/
case audioEqualizer
/**
Stroke.
- returns: Instance of NVActivityIndicatorAnimationCircleStrokeSpin.
*/
case circleStrokeSpin
// swiftlint:disable:next cyclomatic_complexity function_body_length
func animation() -> NVActivityIndicatorAnimationDelegate {
switch self {
case .blank:
return NVActivityIndicatorAnimationBlank()
case .ballPulse:
return NVActivityIndicatorAnimationBallPulse()
case .ballGridPulse:
return NVActivityIndicatorAnimationBallGridPulse()
case .ballClipRotate:
return NVActivityIndicatorAnimationBallClipRotate()
case .squareSpin:
return NVActivityIndicatorAnimationSquareSpin()
case .ballClipRotatePulse:
return NVActivityIndicatorAnimationBallClipRotatePulse()
case .ballClipRotateMultiple:
return NVActivityIndicatorAnimationBallClipRotateMultiple()
case .ballPulseRise:
return NVActivityIndicatorAnimationBallPulseRise()
case .ballRotate:
return NVActivityIndicatorAnimationBallRotate()
case .cubeTransition:
return NVActivityIndicatorAnimationCubeTransition()
case .ballZigZag:
return NVActivityIndicatorAnimationBallZigZag()
case .ballZigZagDeflect:
return NVActivityIndicatorAnimationBallZigZagDeflect()
case .ballTrianglePath:
return NVActivityIndicatorAnimationBallTrianglePath()
case .ballScale:
return NVActivityIndicatorAnimationBallScale()
case .lineScale:
return NVActivityIndicatorAnimationLineScale()
case .lineScaleParty:
return NVActivityIndicatorAnimationLineScaleParty()
case .ballScaleMultiple:
return NVActivityIndicatorAnimationBallScaleMultiple()
case .ballPulseSync:
return NVActivityIndicatorAnimationBallPulseSync()
case .ballBeat:
return NVActivityIndicatorAnimationBallBeat()
case .ballDoubleBounce:
return NVActivityIndicatorAnimationBallDoubleBounce()
case .lineScalePulseOut:
return NVActivityIndicatorAnimationLineScalePulseOut()
case .lineScalePulseOutRapid:
return NVActivityIndicatorAnimationLineScalePulseOutRapid()
case .ballScaleRipple:
return NVActivityIndicatorAnimationBallScaleRipple()
case .ballScaleRippleMultiple:
return NVActivityIndicatorAnimationBallScaleRippleMultiple()
case .ballSpinFadeLoader:
return NVActivityIndicatorAnimationBallSpinFadeLoader()
case .lineSpinFadeLoader:
return NVActivityIndicatorAnimationLineSpinFadeLoader()
case .triangleSkewSpin:
return NVActivityIndicatorAnimationTriangleSkewSpin()
case .pacman:
return NVActivityIndicatorAnimationPacman()
case .ballGridBeat:
return NVActivityIndicatorAnimationBallGridBeat()
case .semiCircleSpin:
return NVActivityIndicatorAnimationSemiCircleSpin()
case .ballRotateChase:
return NVActivityIndicatorAnimationBallRotateChase()
case .orbit:
return NVActivityIndicatorAnimationOrbit()
case .audioEqualizer:
return NVActivityIndicatorAnimationAudioEqualizer()
case .circleStrokeSpin:
return NVActivityIndicatorAnimationCircleStrokeSpin()
}
}
}
/// Function that performs fade in/out animation.
public typealias FadeInAnimation = (UIView) -> Void
/// Function that performs fade out animation.
///
/// - Note: Must call the second parameter on the animation completion.
public typealias FadeOutAnimation = (UIView, @escaping () -> Void) -> Void
// swiftlint:disable file_length
/// Activity indicator view with nice animations
public final class NVActivityIndicatorView: UIView {
// swiftlint:disable identifier_name
/// Default type. Default value is .BallSpinFadeLoader.
public static var DEFAULT_TYPE: NVActivityIndicatorType = .ballSpinFadeLoader
/// Default color of activity indicator. Default value is UIColor.white.
public static var DEFAULT_COLOR = UIColor.white
/// Default color of text. Default value is UIColor.white.
public static var DEFAULT_TEXT_COLOR = UIColor.white
/// Default padding. Default value is 0.
public static var DEFAULT_PADDING: CGFloat = 0
/// Default size of activity indicator view in UI blocker. Default value is 60x60.
public static var DEFAULT_BLOCKER_SIZE = CGSize(width: 60, height: 60)
/// Default display time threshold to actually display UI blocker. Default value is 0 ms.
///
/// - note:
/// Default time that has to be elapsed (between calls of `startAnimating()` and `stopAnimating()`) in order to actually display UI blocker. It should be set thinking about what the minimum duration of an activity is to be worth showing it to the user. If the activity ends before this time threshold, then it will not be displayed at all.
public static var DEFAULT_BLOCKER_DISPLAY_TIME_THRESHOLD = 0
/// Default minimum display time of UI blocker. Default value is 0 ms.
///
/// - note:
/// Default minimum display time of UI blocker. Its main purpose is to avoid flashes showing and hiding it so fast. For instance, setting it to 200ms will force UI blocker to be shown for at least this time (regardless of calling `stopAnimating()` ealier).
public static var DEFAULT_BLOCKER_MINIMUM_DISPLAY_TIME = 0
/// Default message displayed in UI blocker. Default value is nil.
public static var DEFAULT_BLOCKER_MESSAGE: String?
/// Default message spacing to activity indicator view in UI blocker. Default value is 8.
public static var DEFAULT_BLOCKER_MESSAGE_SPACING = CGFloat(8.0)
/// Default font of message displayed in UI blocker. Default value is bold system font, size 20.
public static var DEFAULT_BLOCKER_MESSAGE_FONT = UIFont.boldSystemFont(ofSize: 20)
/// Default background color of UI blocker. Default value is UIColor(red: 0, green: 0, blue: 0, alpha: 0.5)
public static var DEFAULT_BLOCKER_BACKGROUND_COLOR = UIColor(red: 0, green: 0, blue: 0, alpha: 0.5)
/// Default fade in animation.
public static var DEFAULT_FADE_IN_ANIMATION: FadeInAnimation = { view in
view.alpha = 0
UIView.animate(withDuration: 0.25) {
view.alpha = 1
}
}
/// Default fade out animation.
public static var DEFAULT_FADE_OUT_ANIMATION: FadeOutAnimation = { (view, complete) in
UIView.animate(withDuration: 0.25,
animations: {
view.alpha = 0
},
completion: { completed in
if completed {
complete()
}
})
}
// swiftlint:enable identifier_name
/// Animation type.
public var type: NVActivityIndicatorType = NVActivityIndicatorView.DEFAULT_TYPE
@available(*, unavailable, message: "This property is reserved for Interface Builder. Use 'type' instead.")
@IBInspectable var typeName: String {
get {
return getTypeName()
}
set {
_setTypeName(newValue)
}
}
/// Color of activity indicator view.
@IBInspectable public var color: UIColor = NVActivityIndicatorView.DEFAULT_COLOR
/// Padding of activity indicator view.
@IBInspectable public var padding: CGFloat = NVActivityIndicatorView.DEFAULT_PADDING
/// Current status of animation, read-only.
@available(*, deprecated)
public var animating: Bool { return isAnimating }
/// Current status of animation, read-only.
private(set) public var isAnimating: Bool = false
/**
Returns an object initialized from data in a given unarchiver.
self, initialized using the data in decoder.
- parameter decoder: an unarchiver object.
- returns: self, initialized using the data in decoder.
*/
public required init?(coder aDecoder: NSCoder) {
super.init(coder: aDecoder)
backgroundColor = UIColor.clear
isHidden = true
}
/**
Create a activity indicator view.
Appropriate NVActivityIndicatorView.DEFAULT_* values are used for omitted params.
- parameter frame: view's frame.
- parameter type: animation type.
- parameter color: color of activity indicator view.
- parameter padding: padding of activity indicator view.
- returns: The activity indicator view.
*/
public init(frame: CGRect, type: NVActivityIndicatorType? = nil, color: UIColor? = nil, padding: CGFloat? = nil) {
self.type = type ?? NVActivityIndicatorView.DEFAULT_TYPE
self.color = color ?? NVActivityIndicatorView.DEFAULT_COLOR
self.padding = padding ?? NVActivityIndicatorView.DEFAULT_PADDING
super.init(frame: frame)
isHidden = true
}
// Fix issue #62
// Intrinsic content size is used in autolayout
// that causes mislayout when using with MBProgressHUD.
/**
Returns the natural size for the receiving view, considering only properties of the view itself.
A size indicating the natural size for the receiving view based on its intrinsic properties.
- returns: A size indicating the natural size for the receiving view based on its intrinsic properties.
*/
public override var intrinsicContentSize: CGSize {
return CGSize(width: bounds.width, height: bounds.height)
}
public override var bounds: CGRect {
didSet {
// setup the animation again for the new bounds
if oldValue != bounds && isAnimating {
setUpAnimation()
}
}
}
/**
Start animating.
*/
public final func startAnimating() {
guard !isAnimating else {
return
}
isHidden = false
isAnimating = true
layer.speed = 1
setUpAnimation()
}
/**
Stop animating.
*/
public final func stopAnimating() {
guard isAnimating else {
return
}
isHidden = true
isAnimating = false
layer.sublayers?.removeAll()
}
// MARK: Internal
// swiftlint:disable:next identifier_name
func _setTypeName(_ typeName: String) {
for item in NVActivityIndicatorType.allCases {
if String(describing: item).caseInsensitiveCompare(typeName) == ComparisonResult.orderedSame {
type = item
break
}
}
}
func getTypeName() -> String {
return String(describing: type)
}
// MARK: Privates
private final func setUpAnimation() {
let animation: NVActivityIndicatorAnimationDelegate = type.animation()
var animationRect = frame.inset(by: UIEdgeInsets(top: padding, left: padding, bottom: padding, right: padding))
let minEdge = min(animationRect.width, animationRect.height)
layer.sublayers = nil
animationRect.size = CGSize(width: minEdge, height: minEdge)
animation.setUpAnimation(in: layer, size: animationRect.size, color: color)
}
}
#endif