/
CircuitContent.kt
219 lines (199 loc) · 7.15 KB
/
CircuitContent.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
// Copyright (C) 2022 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package com.slack.circuit.foundation
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.SideEffect
import androidx.compose.runtime.key
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import com.slack.circuit.runtime.CircuitContext
import com.slack.circuit.runtime.CircuitUiState
import com.slack.circuit.runtime.InternalCircuitApi
import com.slack.circuit.runtime.Navigator
import com.slack.circuit.runtime.presenter.Presenter
import com.slack.circuit.runtime.screen.PopResult
import com.slack.circuit.runtime.screen.Screen
import com.slack.circuit.runtime.ui.Ui
import kotlinx.collections.immutable.ImmutableList
import kotlinx.collections.immutable.persistentListOf
@Composable
public fun CircuitContent(
screen: Screen,
modifier: Modifier = Modifier,
circuit: Circuit = requireNotNull(LocalCircuit.current),
unavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit) =
circuit.onUnavailableContent,
key: Any? = screen,
) {
CircuitContent(screen, Navigator.NoOp, modifier, circuit, unavailableContent, key)
}
@Composable
public fun CircuitContent(
screen: Screen,
modifier: Modifier = Modifier,
onNavEvent: (event: NavEvent) -> Unit,
circuit: Circuit = requireNotNull(LocalCircuit.current),
unavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit) =
circuit.onUnavailableContent,
key: Any? = screen,
) {
val navigator =
remember(onNavEvent) {
object : Navigator {
override fun goTo(screen: Screen) {
onNavEvent(NavEvent.GoTo(screen))
}
override fun resetRoot(
newRoot: Screen,
saveState: Boolean,
restoreState: Boolean,
): ImmutableList<Screen> {
onNavEvent(NavEvent.ResetRoot(newRoot, saveState, restoreState))
return persistentListOf()
}
override fun pop(result: PopResult?): Screen? {
onNavEvent(NavEvent.Pop(result))
return null
}
override fun peek(): Screen = screen
override fun peekBackStack(): ImmutableList<Screen> = persistentListOf(screen)
}
}
CircuitContent(screen, navigator, modifier, circuit, unavailableContent, key)
}
@Composable
public fun CircuitContent(
screen: Screen,
navigator: Navigator,
modifier: Modifier = Modifier,
circuit: Circuit = requireNotNull(LocalCircuit.current),
unavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit) =
circuit.onUnavailableContent,
key: Any? = screen,
) {
val parent = LocalCircuitContext.current
@OptIn(InternalCircuitApi::class)
val context =
remember(screen, navigator, circuit, parent) {
CircuitContext(parent).also { it.circuit = circuit }
}
CompositionLocalProvider(LocalCircuitContext provides context) {
CircuitContent(screen, modifier, navigator, circuit, unavailableContent, context, key)
}
}
@Composable
internal fun CircuitContent(
screen: Screen,
modifier: Modifier,
navigator: Navigator,
circuit: Circuit,
unavailableContent: (@Composable (screen: Screen, modifier: Modifier) -> Unit),
context: CircuitContext,
key: Any? = screen,
) {
val eventListener = rememberEventListener(screen, context, factory = circuit.eventListenerFactory)
DisposableEffect(eventListener, screen, context) { onDispose { eventListener.dispose() } }
val presenter = rememberPresenter(screen, navigator, context, eventListener, circuit::presenter)
val ui = rememberUi(screen, context, eventListener, circuit::ui)
if (ui != null && presenter != null) {
(CircuitContent(screen, presenter, ui, modifier, eventListener, key))
} else {
eventListener.onUnavailableContent(screen, presenter, ui, context)
unavailableContent(screen, modifier)
}
}
@Composable
public fun <UiState : CircuitUiState> CircuitContent(
screen: Screen,
presenter: Presenter<UiState>,
ui: Ui<UiState>,
modifier: Modifier = Modifier,
eventListener: EventListener = EventListener.NONE,
key: Any? = screen,
): Unit =
// While the screen is different, in the eyes of compose its position is _the same_, meaning
// we need to wrap the ui and presenter in a key() to force recomposition if it changes. A good
// example case of this is when you have code that calls CircuitContent with a common screen with
// different inputs (but thus same presenter instance type) and you need this to recompose with
// a different presenter.
key(key) {
DisposableEffect(screen) {
eventListener.onStartPresent()
onDispose { eventListener.onDisposePresent() }
}
val state = presenter.present()
// TODO not sure why stateFlow + LaunchedEffect + distinctUntilChanged doesn't work here
SideEffect { eventListener.onState(state) }
DisposableEffect(screen) {
eventListener.onStartContent()
onDispose { eventListener.onDisposeContent() }
}
ui.Content(state, modifier)
}
/**
* Remembers a new [EventListener] instance for the given [screen] and [context].
*
* @param startOnInit indicates whether to call [EventListener.start] automatically after
* instantiation. True by default.
* @param factory a factory to create the [EventListener].
*/
@Suppress("NOTHING_TO_INLINE")
@Composable
public inline fun rememberEventListener(
screen: Screen,
context: CircuitContext = CircuitContext.EMPTY,
startOnInit: Boolean = true,
factory: EventListener.Factory? = null,
): EventListener {
return remember(screen, context) {
(factory?.create(screen, context) ?: EventListener.NONE).also {
if (startOnInit) {
it.start()
}
}
}
}
/**
* Remembers a new [Presenter] instance for the given [screen], [navigator], [context], and
* [eventListener].
*
* @param factory a factory to create the [Presenter].
*/
@Suppress("NOTHING_TO_INLINE")
@Composable
public inline fun rememberPresenter(
screen: Screen,
navigator: Navigator = Navigator.NoOp,
context: CircuitContext = CircuitContext.EMPTY,
eventListener: EventListener = EventListener.NONE,
factory: Presenter.Factory,
): Presenter<CircuitUiState>? =
remember(eventListener, screen, navigator, context) {
eventListener.onBeforeCreatePresenter(screen, navigator, context)
@Suppress("UNCHECKED_CAST")
(factory.create(screen, navigator, context) as Presenter<CircuitUiState>?).also {
eventListener.onAfterCreatePresenter(screen, navigator, it, context)
}
}
/**
* Remembers a new [Ui] instance for the given [screen], [context], and [eventListener].
*
* @param factory a factory to create the [Ui].
*/
@Suppress("NOTHING_TO_INLINE")
@Composable
public inline fun rememberUi(
screen: Screen,
context: CircuitContext = CircuitContext.EMPTY,
eventListener: EventListener = EventListener.NONE,
factory: Ui.Factory,
): Ui<CircuitUiState>? =
remember(eventListener, screen, context) {
eventListener.onBeforeCreateUi(screen, context)
@Suppress("UNCHECKED_CAST")
(factory.create(screen, context) as Ui<CircuitUiState>?).also { ui ->
eventListener.onAfterCreateUi(screen, ui, context)
}
}