FUICheckoutIndicatorView

@MainActor
open class FUICheckoutIndicatorView : NibDesignable

FUICheckoutIndicatorView is an IBDesignable UI component. It uses three distinct states to indicate the progress of a download inProgress, along with completed or failed statuses. These states can be toggled by modifying the displayState property.

Initialization

Programmatically:

let checkoutIndicatorView = FUICheckoutIndicatorView(frame: CGRect())

Inside a Storyboard or xib:

  1. Drag and drop a UIView component to Interface Builder’s canvas.
  2. Switch custom class name from UIView to FUICheckoutIndicatorView and set module to SAPFiori.
  3. Create an outlet of the FUICheckoutIndicatorView to be able to access its properties.

Usage

// After the checkout indicator view is shown, you might want to start a lengthy (download or finalization) process e.g. synchronize data.
// Once this process is complete, change the displayState to .completed and hide the view when the completion handler is called:
checkoutIndicatorView.state = .completed {
   self.checkoutIndicatorView.isHidden = true
}

Theming

Supported style classes

fdlFUICheckoutIndicatorView

Public Enums

Styling & Tinting

  • Tint color for completed state

    Declaration

    Swift

    @MainActor
public var completedTintColor: UIColor { get set }

  • Tint color for failed state

    Declaration

    Swift

    @MainActor
public var failedTintColor: UIColor { get set }

  • Tint color for the AI in progress state

    Declaration

    Swift

    @MainActor
public var aiProgressTintColor: UIColor { get set }

  • UIImage for the AI in progress state

    Declaration

    Swift

    @MainActor
public var aiProgressImage: UIImage? { get set }

  • The current DisplayState of this checkout indicator. The initial value is DisplayState.processing. Changing the displayState property will trigger a redraw of the view.

    Declaration

    Swift

    @MainActor
public private(set) var displayState: DisplayState { get }

  • Changes the display state of this view. This changes the visual appearance of the view.

    Declaration

    Swift

    @MainActor
public func changeDisplayState(to newState: DisplayState, completion: (() -> Void)? = nil)

    Parameters

    newState

    the new display state to switch to.
    completion

    completion handler that will be called, once the display state change is done.