circuit-foundation/com.slack.circuit.foundation/Circuit/Builder

Builder

class Builder(source)

Constructors

constructor()

Properties

defaultNavDecoration

var defaultNavDecoration: NavDecoration

eventListenerFactory

var eventListenerFactory: EventListener.Factory?

onUnavailableContent

var onUnavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit

presenterFactories

val presenterFactories: MutableList<Presenter.Factory>

presentWithLifecycle

var presentWithLifecycle: Boolean

val uiFactories: MutableList<Ui.Factory>

Functions

inline fun <S : Screen, UiState : CircuitUiState> addPresenter(presenter: Presenter<UiState>): Circuit.Builder

inline fun <S : Screen, UiState : CircuitUiState> addPresenter(crossinline factory: (screen: S, navigator: Navigator, context: CircuitContext) -> Presenter<UiState>): Circuit.Builder

addPresenterFactories

fun addPresenterFactories(factories: Iterable<Presenter.Factory>): Circuit.Builder

addPresenterFactory

fun addPresenterFactory(factory: Presenter.Factory): Circuit.Builder

fun addPresenterFactory(vararg factory: Presenter.Factory): Circuit.Builder

inline fun <S : Screen, UiState : CircuitUiState> addStaticUi(crossinline content: @Composable (screen: S, modifier: Modifier) -> Unit): Circuit.Builder

Adds a static UI that does not require a presenter. This is useful for screens that do not have computed state. They can either be stateless or use the given screen as an input for its state.

inline fun <S : Screen, UiState : CircuitUiState> addUi(crossinline content: @Composable (state: UiState, modifier: Modifier) -> Unit): Circuit.Builder

fun addUiFactories(factories: Iterable<Ui.Factory>): Circuit.Builder

fun addUiFactory(factory: Ui.Factory): Circuit.Builder

fun addUiFactory(vararg factory: Ui.Factory): Circuit.Builder

fun build(): Circuit

eventListenerFactory

fun eventListenerFactory(factory: EventListener.Factory): Circuit.Builder

presentWithLifecycle

fun presentWithLifecycle(enable: Boolean = true): Circuit.Builder

setDefaultNavDecoration

fun setDefaultNavDecoration(decoration: NavDecoration): Circuit.Builder

setOnUnavailableContent

fun setOnUnavailableContent(content: @Composable (screen: Screen, modifier: Modifier) -> Unit): Circuit.Builder