RSDStepProgressView

@IBDesignable
open class RSDStepProgressView : UIView, RSDViewDesignable

RSDStepProgressView is a UI element that displays a progress bar drawn horizontally from left to right.

This view includes an optional pointer to stepCountLabel which is not a subview of this view but can be used to display current step and number of steps.

The view controller must set currentStep and totalSteps to cause progress to be displayed.

  • A pointer to the label that should be updated with the current progress.

    Declaration

    Swift

    @IBOutlet
public weak var stepCountLabel: UILabel?

  • The current step in the current flow.

    Declaration

    Swift

    @IBInspectable
public var currentStep: Int { get set }

  • The total number of steps in the current flow.

    Declaration

    Swift

    @IBInspectable
open var totalSteps: Int { get set }

  • Should the progress bar display with rounded ends?

    Declaration

    Swift

    @IBInspectable
open var hasRoundedEnds: Bool { get set }

  • Should the inner progress bar end be rounded on the right side?

    Declaration

    Swift

    open var hasRoundedProgressEnd: Bool { get set }

  • The background color mapping that this view should use as its key. Typically, for all but the top-level views, this will be the background of the superview.

    Declaration

    Swift

    open private(set) var backgroundColorTile: RSDColorTile? {
  get
  }

  • The design system for this component.

    Declaration

    Swift

    open private(set) var designSystem: RSDDesignSystem? {
  get
  }

  • Views can be used in nibs and storyboards without setting up a design system for them. This allows for setting up views to use the same design system and background color mapping as their parent view.

    Declaration

    Swift

    open func setDesignSystem(_ designSystem: RSDDesignSystem, with background: RSDColorTile)

  • The height of the actual progress bar.

    Declaration

    Swift

    @IBInspectable
open var progressLineHeight: CGFloat { get set }

  • The progress (0 - 1.0) to display.

    Declaration

    Swift

    public var progress: CGFloat { get }

  • Returns true if the total steps is greather than 0.

    Declaration

    Swift

    public var hasProgress: Bool { get }

  • The text of the label that is displayed directly under the progress bar.

    Declaration

    Swift

    open func stringForLabel() -> String?

View Life-cycle

  • Sets the text of the progress view label. Default = attributedStringForLabel()

    Declaration

    Swift

    open func updateLabel()