-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename CircuitConfig -> Circuit (#770)
- Loading branch information
Showing
23 changed files
with
295 additions
and
282 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
198 changes: 198 additions & 0 deletions
198
circuit-foundation/src/commonMain/kotlin/com/slack/circuit/foundation/Circuit.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| // Copyright (C) 2022 Slack Technologies, LLC | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| package com.slack.circuit.foundation | ||
|
|
||
| import androidx.compose.foundation.background | ||
| import androidx.compose.foundation.text.BasicText | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.Immutable | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.graphics.Color | ||
| import androidx.compose.ui.text.TextStyle | ||
| import com.slack.circuit.backstack.NavDecoration | ||
| import com.slack.circuit.runtime.CircuitContext | ||
| import com.slack.circuit.runtime.InternalCircuitApi | ||
| import com.slack.circuit.runtime.Navigator | ||
| import com.slack.circuit.runtime.Screen | ||
| import com.slack.circuit.runtime.presenter.Presenter | ||
| import com.slack.circuit.runtime.ui.Ui | ||
|
|
||
| /** | ||
| * [Circuit] adapts [presenter factories][Presenter.Factory] to their corresponding | ||
| * [ui factories][Ui.Factory] using [screens][Screen]. Create instances using [the Builder] | ||
| * [Builder] and create new [CircuitContent] with it to run presenter/UI pairings. | ||
| * | ||
| * ## Construction | ||
| * | ||
| * Construction of [Circuit] instances is done using [the Builder] [Builder]. | ||
| * | ||
| * ```kotlin | ||
| * val circuit = Circuit.Builder() | ||
| * .addUiFactory(AddFavoritesUiFactory()) | ||
| * .addPresenterFactory(AddFavoritesPresenterFactory()) | ||
| * .build() | ||
| * ``` | ||
| * | ||
| * ## Usage | ||
| * | ||
| * These instances can then be used with the composable [CircuitContent] functions to run | ||
| * presenter/UI pairings for individual [screens][Screen]. | ||
| * | ||
| * Circuit instances are consumed within these composable functions via the | ||
| * [CircuitCompositionLocals] CompositionLocalProvider. | ||
| * | ||
| * ```kotlin | ||
| * CircuitCompositionLocals(circuit) { | ||
| * CircuitContent(AddFavoritesScreen()) | ||
| * } | ||
| * ``` | ||
| * | ||
| * If using navigation, use `NavigableCircuitContent` instead. | ||
| * | ||
| * ```kotlin | ||
| * val backstack = rememberSaveableBackStack { push(AddFavoritesScreen()) } | ||
| * val navigator = rememberCircuitNavigator(backstack, ::onBackPressed) | ||
| * CircuitCompositionLocals(circuit) { | ||
| * NavigableCircuitContent(navigator, backstack) | ||
| * } | ||
| * ``` | ||
| * | ||
| * @see CircuitContent | ||
| * @see `rememberCircuitNavigator` | ||
| * @see `NavigableCircuitContent` | ||
| */ | ||
| @Immutable | ||
| public class Circuit private constructor(builder: Builder) { | ||
| private val uiFactories: List<Ui.Factory> = builder.uiFactories.toList() | ||
| private val presenterFactories: List<Presenter.Factory> = builder.presenterFactories.toList() | ||
| public val onUnavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit) = | ||
| builder.onUnavailableContent | ||
| public val defaultNavDecoration: NavDecoration = builder.defaultNavDecoration | ||
| internal val eventListenerFactory: EventListener.Factory? = builder.eventListenerFactory | ||
|
|
||
| @OptIn(InternalCircuitApi::class) | ||
| public fun presenter( | ||
| screen: Screen, | ||
| navigator: Navigator, | ||
| context: CircuitContext = CircuitContext(null).also { it.circuit = this } | ||
| ): Presenter<*>? { | ||
| return nextPresenter(null, screen, navigator, context) | ||
| } | ||
|
|
||
| public fun nextPresenter( | ||
| skipPast: Presenter.Factory?, | ||
| screen: Screen, | ||
| navigator: Navigator, | ||
| context: CircuitContext | ||
| ): Presenter<*>? { | ||
| val start = presenterFactories.indexOf(skipPast) + 1 | ||
| for (i in start until presenterFactories.size) { | ||
| val presenter = presenterFactories[i].create(screen, navigator, context) | ||
| if (presenter != null) { | ||
| return presenter | ||
| } | ||
| } | ||
|
|
||
| return null | ||
| } | ||
|
|
||
| @OptIn(InternalCircuitApi::class) | ||
| public fun ui( | ||
| screen: Screen, | ||
| context: CircuitContext = CircuitContext(null).also { it.circuit = this } | ||
| ): Ui<*>? { | ||
| return nextUi(null, screen, context) | ||
| } | ||
|
|
||
| public fun nextUi(skipPast: Ui.Factory?, screen: Screen, context: CircuitContext): Ui<*>? { | ||
| val start = uiFactories.indexOf(skipPast) + 1 | ||
| for (i in start until uiFactories.size) { | ||
| val ui = uiFactories[i].create(screen, context) | ||
| if (ui != null) { | ||
| return ui | ||
| } | ||
| } | ||
|
|
||
| return null | ||
| } | ||
|
|
||
| public fun newBuilder(): Builder = Builder(this) | ||
|
|
||
| public class Builder constructor() { | ||
| public val uiFactories: MutableList<Ui.Factory> = mutableListOf() | ||
| public val presenterFactories: MutableList<Presenter.Factory> = mutableListOf() | ||
| public var onUnavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit) = | ||
| UnavailableContent | ||
| private set | ||
|
|
||
| public var defaultNavDecoration: NavDecoration = NavigatorDefaults.DefaultDecoration | ||
| private set | ||
|
|
||
| public var eventListenerFactory: EventListener.Factory? = null | ||
| private set | ||
|
|
||
| internal constructor(circuit: Circuit) : this() { | ||
| uiFactories.addAll(circuit.uiFactories) | ||
| presenterFactories.addAll(circuit.presenterFactories) | ||
| eventListenerFactory = circuit.eventListenerFactory | ||
| } | ||
|
|
||
| public fun addUiFactory(factory: Ui.Factory): Builder = apply { uiFactories.add(factory) } | ||
|
|
||
| public fun addUiFactory(vararg factory: Ui.Factory): Builder = apply { | ||
| for (f in factory) { | ||
| uiFactories.add(f) | ||
| } | ||
| } | ||
|
|
||
| public fun addUiFactories(factories: Iterable<Ui.Factory>): Builder = apply { | ||
| uiFactories.addAll(factories) | ||
| } | ||
|
|
||
| public fun addPresenterFactory(factory: Presenter.Factory): Builder = apply { | ||
| presenterFactories.add(factory) | ||
| } | ||
|
|
||
| public fun addPresenterFactory(vararg factory: Presenter.Factory): Builder = apply { | ||
| for (f in factory) { | ||
| presenterFactories.add(f) | ||
| } | ||
| } | ||
|
|
||
| public fun addPresenterFactories(factories: Iterable<Presenter.Factory>): Builder = apply { | ||
| presenterFactories.addAll(factories) | ||
| } | ||
|
|
||
| public fun setOnUnavailableContent( | ||
| content: @Composable (screen: Screen, modifier: Modifier) -> Unit | ||
| ): Builder = apply { onUnavailableContent = content } | ||
|
|
||
| public fun setDefaultNavDecoration(decoration: NavDecoration): Builder = apply { | ||
| defaultNavDecoration = decoration | ||
| } | ||
|
|
||
| public fun eventListenerFactory(factory: EventListener.Factory): Builder = apply { | ||
| eventListenerFactory = factory | ||
| } | ||
|
|
||
| public fun build(): Circuit { | ||
| return Circuit(this) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private val UnavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = | ||
| { screen, modifier -> | ||
| BasicText( | ||
| "Route not available: ${screen::class.qualifiedName}", | ||
| modifier.background(Color.Red), | ||
| style = TextStyle(color = Color.Yellow) | ||
| ) | ||
| } | ||
|
|
||
| /** The [Circuit] used in this context. */ | ||
| public var CircuitContext.circuit: Circuit | ||
| get() = checkNotNull(tag()) | ||
| set(value) { | ||
| putTag(value) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.