libux/io.mimi.sdk.ux.flow

Package-level declarations

Types

ButtonFooterSection

class ButtonFooterSection(view: View) : FooterSection

A FooterSection with a button whose purpose is usually to navigate to the following step.

Event

class Event<out T>(content: T)

EventBus

class EventBus<T>

Class to wrap the Events needed for navigating between screens

Flow

data class Flow(val steps: List<Step>)

An A -> B flow that contains a list of Step in the order that the flow is intended to execute.

FlowCoordinator

class FlowCoordinator

FlowCoordinator is responsible for coordinating the navigation_profile inside a Flow. It will step back and forth in Flow and dequeue the current Step. The current StepFragment is passed to the fragmentManager so the Step is in control of that fragment.

FlowCoordinatorFactory

object FlowCoordinatorFactory

Class that contains all the creation/initialization methods for the FlowCoordinator

FlowListener

interface FlowListener

Informs its clients about progress of FlowCoordinator in Flow

FlowLocation

sealed class FlowLocation

The location of a Step in a Flow.

NavigationEvent

enum NavigationEvent : Enum<NavigationEvent>

Class used to identify the possible flows for Navigation Events

NavigationEventViewModel

class NavigationEventViewModel : ViewModel

Class used to handle Navigation Events

SimpleStep

open class SimpleStep(data: SimpleStepData) : Step

SimpleStepData

data class SimpleStepData(val toolbarData: ToolbarData? = null, val headerText: String = "", val footerText: String = "", val showHeader: Boolean = true, val footerButtonOnTap: () -> FlowLocation? = { FlowLocation.Next })

Class containing the data to be displayed on each Screen Step

Step

abstract class Step(val toolbarData: ToolbarData? = null) : CoroutineScope

Base controller that controls the fragment of a Step. It is a controller in the context of the MVC architectural pattern. This controller is responsible for populating the fragment with the sections HeaderSection, ContentSection and FooterSection.

TitleHeaderSection

class TitleHeaderSection(view: View) : HeaderSection

Displays the title headline, if any, of a Step.

ToolbarData

data class ToolbarData(val title: String = "", val isUpButtonVisible: Boolean = false, var isTitleVisible: Boolean = true)

Class containing Toolbar data from the Step

Functions

observeEventNotHandled

fun <T> LiveData<Event<T>>.observeEventNotHandled(owner: LifecycleOwner, observer: (T) -> Unit)

Utility method to ease the process of unhandled Events