MimiUserFlowStep

open class MimiUserFlowStep<ContentViewController, HeaderView, FooterView> : NSObject, MimiCoordinatableUserFlowSteppable, MimiThemeable where ContentViewController : UIViewController, HeaderView : MimiUserFlowStepHeaderView, FooterView : MimiUserFlowStepFooterView

An individual step that makes up part of a flow, mapping 1:1 with a screen that appears in the flow.

The Step is responsible for populating and controlling the on screen UI elements, and has the power to dictate flow navigation as well.

  • coordinator
    Declaration

    Swift

    public internal(set) weak var coordinator: MimiUserFlowCoordinator! { get }
  • navigationItem
    Declaration

    Swift

    public internal(set) var navigationItem: MimiUserFlowNavigationItemable? { get }
  • view

    The view that the step is displayed in.

    Declaration

    Swift

    public internal(set) weak var view: UIView? { get }
  • content

    The footer view controller for the step.

    Declaration

    Swift

    public private(set) weak var content: ContentViewController! { get }
  • header

    The header view controller for the step.

    Declaration

    Swift

    public private(set) weak var header: HeaderView! { get }
  • footer

    The footer view controller for the step.

    Declaration

    Swift

    public private(set) weak var footer: FooterView! { get }
  • backgroundColor

    Background color to use for flow container view controllers.

    If nil, will attempt to use theme colors or default to systemBackground / white.

    Declaration

    Swift

    open var backgroundColor: UIColor { get }
  • supportedInterfaceOrientations

    Returns all of the interface orientations that the step supports.

    This defaults to .all on iPad and .portrait only on iPhone.

    Declaration

    Swift

    open var supportedInterfaceOrientations: UIInterfaceOrientationMask { get }
  • isModalInPresentation

    A Boolean value indicating whether the view controller enforces a modal behavior.

    The default value of this property is false. When you set it to true, UIKit ignores events outside the view controller’s bounds and prevents the interactive dismissal of the view controller while it is onscreen.

    Declaration

    Swift

    open var isModalInPresentation: Bool { get set }
  • layoutContentToSafeArea

    Whether to constrain the content views within the step to the presented safe area. Defaults to true.

    Declaration

    Swift

    open var layoutContentToSafeArea: Bool { get }
  • requiresFullWidth

    Whether the view requires to be full width, and ignore any horizontal insets.

    The default value of this property is false.

    Declaration

    Swift

    open var requiresFullWidth: Bool { get }

Lifecycle

Theming

Transitioning