Skip to content

Commit dde493c

Browse files
jyaganehjyaganeh
authored
Refactor AirshipEmbeddedViewGroup to expose hoistable state (#1659)
1 parent 23c9d2e commit dde493c

File tree

3 files changed

+156
-47
lines changed

3 files changed

+156
-47
lines changed

‎urbanairship-automation-compose/src/main/java/com/urbanairship/automation/compose/AirshipEmbeddedViewGroup.kt

+36-46
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,30 @@ import androidx.compose.foundation.layout.fillMaxSize
88
import androidx.compose.foundation.layout.fillMaxWidth
99
import androidx.compose.runtime.Composable
1010
import androidx.compose.runtime.Immutable
11+
import androidx.compose.runtime.LaunchedEffect
12+
import androidx.compose.runtime.Stable
1113
import androidx.compose.runtime.State
12-
import androidx.compose.runtime.collectAsState
1314
import androidx.compose.runtime.derivedStateOf
15+
import androidx.compose.runtime.getValue
16+
import androidx.compose.runtime.mutableStateListOf
17+
import androidx.compose.runtime.mutableStateOf
18+
import androidx.compose.runtime.remember
1419
import androidx.compose.runtime.rememberCoroutineScope
20+
import androidx.compose.runtime.setValue
1521
import androidx.compose.runtime.structuralEqualityPolicy
1622
import androidx.compose.ui.Modifier
1723
import androidx.compose.ui.platform.LocalContext
1824
import androidx.compose.ui.tooling.preview.Preview
1925
import androidx.lifecycle.compose.collectAsStateWithLifecycle
26+
import com.urbanairship.android.layout.AirshipEmbeddedViewManager
2027
import com.urbanairship.android.layout.EmbeddedDisplayRequest
2128
import com.urbanairship.android.layout.ui.EmbeddedLayout
2229
import com.urbanairship.embedded.AirshipEmbeddedInfo
2330
import com.urbanairship.embedded.EmbeddedViewManager
31+
import kotlinx.coroutines.Dispatchers
2432
import kotlinx.coroutines.flow.distinctUntilChanged
2533
import kotlinx.coroutines.flow.map
34+
import kotlinx.coroutines.withContext
2635

2736
/**
2837
* A container that allows all embedded content for the given [embeddedId]
@@ -40,56 +49,37 @@ public fun AirshipEmbeddedViewGroup(
4049
comparator: Comparator<AirshipEmbeddedInfo>? = null,
4150
content: @Composable BoxScope.(embeddedViews: List<EmbeddedViewItem>) -> Unit
4251
) {
43-
val scope = rememberCoroutineScope()
44-
45-
val displayRequests = EmbeddedViewManager.displayRequests(embeddedId, comparator, scope)
46-
.map { it.list }
47-
.distinctUntilChanged()
48-
.collectAsStateWithLifecycle(emptyList())
49-
50-
val items: State<List<EmbeddedViewItem>> = derivedStateOf(policy = structuralEqualityPolicy()) {
51-
displayRequests.value.map { request -> EmbeddedViewItem(request = request) }
52-
}
53-
54-
Box(modifier) {
55-
content(items.value)
56-
}
52+
AirshipEmbeddedViewGroup(
53+
modifier = modifier,
54+
state = rememberAirshipEmbeddedViewGroupState(embeddedId, comparator),
55+
content = content
56+
)
5757
}
5858

5959
/**
60-
* An embedded view item, containing the [AirshipEmbeddedInfo] and the content to display.
60+
* A container that allows all embedded content for the `embeddedId` defined on the given
61+
* [AirshipEmbeddedViewGroupState] instance.
62+
*
63+
* This composable may be useful when access to the embedded view group state is needed outside of
64+
* the `AirshipEmbeddedViewGroup` composable, embedded view group state should be hoisted, and for
65+
* advanced custom logic that depends on the availability of embedded view content.
66+
*
67+
* When included inside of a lazy composable or scrolling list, state should be hoisted up, above
68+
* the lazy composable or scrolling list, in order to ensure that the embedded view group state is
69+
* maintained across recompositions.
70+
*
71+
* @param state The [AirshipEmbeddedViewGroupState] to be used by this embedded view group.
72+
* @param modifier The modifier to be applied to the layout.
73+
* @param content The `Composable` that will display the list of embedded view content.
6174
*/
62-
@Immutable
63-
public data class EmbeddedViewItem internal constructor(
64-
private val request: EmbeddedDisplayRequest
75+
@Composable
76+
public fun AirshipEmbeddedViewGroup(
77+
state: AirshipEmbeddedViewGroupState,
78+
modifier: Modifier = Modifier,
79+
content: @Composable BoxScope.(embeddedViews: List<EmbeddedViewItem>) -> Unit
6580
) {
66-
/** The [AirshipEmbeddedInfo] for this embedded content. */
67-
public val info: AirshipEmbeddedInfo = AirshipEmbeddedInfo(
68-
embeddedId = request.embeddedViewId,
69-
instanceId = request.viewInstanceId,
70-
priority = request.priority,
71-
extras = request.extras,
72-
)
73-
74-
/** The content to display for this embedded view item. */
75-
@Composable
76-
public fun content() {
77-
val layout = EmbeddedLayout(
78-
context = LocalContext.current,
79-
embeddedViewId = request.embeddedViewId,
80-
viewInstanceId = request.viewInstanceId,
81-
args = request.displayArgsProvider.invoke(),
82-
embeddedViewManager = EmbeddedViewManager
83-
)
84-
85-
EmbeddedViewWrapper(
86-
embeddedId = request.embeddedViewId,
87-
embeddedLayout = layout,
88-
embeddedSize = layout.getPlacement()?.size?.toEmbeddedSize(),
89-
// Consumers provide their own placeholder, if desired.
90-
placeholder = null,
91-
modifier = Modifier.fillMaxWidth()
92-
)
81+
Box(modifier) {
82+
content(state.items.value)
9383
}
9484
}
9585

‎urbanairship-automation-compose/src/main/java/com/urbanairship/automation/compose/AirshipEmbeddedViewGroupState.kt

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
package com.urbanairship.automation.compose
2+
3+
import androidx.compose.foundation.layout.fillMaxWidth
4+
import androidx.compose.runtime.Composable
5+
import androidx.compose.runtime.Immutable
6+
import androidx.compose.runtime.LaunchedEffect
7+
import androidx.compose.runtime.Stable
8+
import androidx.compose.runtime.State
9+
import androidx.compose.runtime.derivedStateOf
10+
import androidx.compose.runtime.getValue
11+
import androidx.compose.runtime.mutableStateOf
12+
import androidx.compose.runtime.remember
13+
import androidx.compose.runtime.rememberCoroutineScope
14+
import androidx.compose.runtime.setValue
15+
import androidx.compose.runtime.structuralEqualityPolicy
16+
import androidx.compose.ui.Modifier
17+
import androidx.compose.ui.platform.LocalContext
18+
import com.urbanairship.android.layout.AirshipEmbeddedViewManager
19+
import com.urbanairship.android.layout.EmbeddedDisplayRequest
20+
import com.urbanairship.android.layout.ui.EmbeddedLayout
21+
import com.urbanairship.embedded.AirshipEmbeddedInfo
22+
import com.urbanairship.embedded.EmbeddedViewManager
23+
import kotlinx.coroutines.Dispatchers
24+
import kotlinx.coroutines.flow.distinctUntilChanged
25+
import kotlinx.coroutines.flow.map
26+
import kotlinx.coroutines.withContext
27+
28+
/**
29+
* Creates a [AirshipEmbeddedViewGroupState] that can be used to manage the state of an embedded
30+
* view group.
31+
*
32+
* @param embeddedId the embedded ID.
33+
* @param comparator optional `Comparator` used to sort available embedded contents.
34+
*
35+
* @return a new [AirshipEmbeddedViewGroupState] instance.
36+
*/
37+
@Composable
38+
public fun rememberAirshipEmbeddedViewGroupState(
39+
embeddedId: String,
40+
comparator: Comparator<AirshipEmbeddedInfo>? = null
41+
): AirshipEmbeddedViewGroupState {
42+
return rememberAirshipEmbeddedViewGroupState(embeddedId, comparator, EmbeddedViewManager)
43+
}
44+
45+
/**
46+
* State holder for [AirshipEmbeddedViewGroup] content.
47+
*
48+
* @param embeddedId the embedded ID.
49+
*/
50+
@Stable
51+
public class AirshipEmbeddedViewGroupState(
52+
public val embeddedId: String
53+
) {
54+
internal var displayRequests by mutableStateOf<List<EmbeddedDisplayRequest>>(emptyList())
55+
56+
/** Embedded view items, containing the [AirshipEmbeddedInfo] and content to display. */
57+
public val items: State<List<EmbeddedViewItem>> = derivedStateOf(policy = structuralEqualityPolicy()) {
58+
displayRequests.map { request -> EmbeddedViewItem(request = request) }
59+
}
60+
}
61+
62+
@Composable
63+
internal fun rememberAirshipEmbeddedViewGroupState(
64+
embeddedId: String,
65+
comparator: Comparator<AirshipEmbeddedInfo>?,
66+
embeddedViewManager: AirshipEmbeddedViewManager,
67+
): AirshipEmbeddedViewGroupState {
68+
val state = remember { AirshipEmbeddedViewGroupState(embeddedId) }
69+
val scope = rememberCoroutineScope()
70+
71+
LaunchedEffect(embeddedId, comparator) {
72+
withContext(Dispatchers.Default) {
73+
embeddedViewManager.displayRequests(embeddedId, comparator, scope)
74+
.map { it.list }
75+
.distinctUntilChanged()
76+
.collect { state.displayRequests = it }
77+
}
78+
}
79+
80+
return state
81+
}
82+
83+
84+
/**
85+
* An embedded view item, containing the [AirshipEmbeddedInfo] and the content to display.
86+
*/
87+
@Immutable
88+
public data class EmbeddedViewItem internal constructor(
89+
private val request: EmbeddedDisplayRequest
90+
) {
91+
/** The [AirshipEmbeddedInfo] for this embedded content. */
92+
public val info: AirshipEmbeddedInfo = AirshipEmbeddedInfo(
93+
embeddedId = request.embeddedViewId,
94+
instanceId = request.viewInstanceId,
95+
priority = request.priority,
96+
extras = request.extras,
97+
)
98+
99+
/** The content to display for this embedded view item. */
100+
@Composable
101+
public fun content() {
102+
val layout = EmbeddedLayout(
103+
context = LocalContext.current,
104+
embeddedViewId = request.embeddedViewId,
105+
viewInstanceId = request.viewInstanceId,
106+
args = request.displayArgsProvider.invoke(),
107+
embeddedViewManager = EmbeddedViewManager
108+
)
109+
110+
EmbeddedViewWrapper(
111+
embeddedId = request.embeddedViewId,
112+
embeddedLayout = layout,
113+
embeddedSize = layout.getPlacement()?.size?.toEmbeddedSize(),
114+
// Consumers provide their own placeholder, if desired.
115+
placeholder = null,
116+
modifier = Modifier.fillMaxWidth()
117+
)
118+
}
119+
}

‎urbanairship-automation-compose/src/main/java/com/urbanairship/automation/compose/AirshipEmbeddedViewState.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public fun rememberAirshipEmbeddedViewState(
4141
return rememberAirshipEmbeddedViewState(embeddedId, comparator, EmbeddedViewManager)
4242
}
4343

44-
/** State holder for [EmbeddedViewContent]. */
44+
/** State holder for [AirshipEmbeddedView] content. */
4545
@Stable
4646
public class AirshipEmbeddedViewState(
4747
public val embeddedId: String

0 commit comments

Comments
 (0)