forked from microsoft/fluentui-android
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Snackbar.kt
252 lines (237 loc) · 9.92 KB
/
Snackbar.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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
package com.microsoft.fluentui.tokenized.notification
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.layout.*
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.foundation.text.BasicText
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Close
import androidx.compose.material.ripple.rememberRipple
import androidx.compose.runtime.*
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.graphicsLayer
import androidx.compose.ui.platform.testTag
import androidx.compose.ui.semantics.LiveRegionMode
import androidx.compose.ui.semantics.Role
import androidx.compose.ui.semantics.liveRegion
import androidx.compose.ui.semantics.semantics
import androidx.compose.ui.unit.dp
import com.microsoft.fluentui.theme.FluentTheme
import com.microsoft.fluentui.theme.token.ControlTokens
import com.microsoft.fluentui.theme.token.FluentIcon
import com.microsoft.fluentui.theme.token.Icon
import com.microsoft.fluentui.theme.token.StateColor
import com.microsoft.fluentui.theme.token.controlTokens.*
import com.microsoft.fluentui.tokenized.controls.Button
import kotlinx.coroutines.CancellableContinuation
import kotlinx.coroutines.delay
import kotlinx.coroutines.suspendCancellableCoroutine
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import kotlin.coroutines.resume
// TAGS FOR TESTING
const val SNACK_BAR = "Fluent Snack bar"
const val SNACK_BAR_ICON = "Fluent Snack bar Icon"
const val SNACK_BAR_SUBTITLE = "Fluent Snack bar Subtitle"
const val SNACK_BAR_ACTION_BUTTON = "Fluent Snack bar Action Button"
const val SNACK_BAR_DISMISS_BUTTON = "Fluent Snack bar Dismiss Button"
class SnackbarMetadata(
val message: String,
val style: SnackbarStyle,
val enableDismiss: Boolean,
val icon: FluentIcon?,
val subTitle: String?,
val actionText: String?,
val duration: NotificationDuration,
private val continuation: CancellableContinuation<NotificationResult>
) : NotificationMetadata {
override fun clicked() {
if (continuation.isActive) continuation.resume(NotificationResult.CLICKED)
}
override fun dismiss() {
if (continuation.isActive) continuation.resume(NotificationResult.DISMISSED)
}
override fun timedOut() {
if (continuation.isActive) continuation.resume(NotificationResult.TIMEOUT)
}
}
class SnackbarState {
private val mutex = Mutex()
var currentSnackbar by mutableStateOf<SnackbarMetadata?>(null)
suspend fun showSnackbar(
message: String,
style: SnackbarStyle = SnackbarStyle.Neutral,
enableDismiss: Boolean = false,
icon: FluentIcon? = null,
subTitle: String? = null,
actionText: String? = null,
duration: NotificationDuration = NotificationDuration.SHORT
): NotificationResult {
mutex.withLock {
try {
return suspendCancellableCoroutine { it ->
currentSnackbar = SnackbarMetadata(
message,
style,
enableDismiss,
icon,
subTitle,
actionText,
duration,
it
)
}
} finally {
currentSnackbar = null
delay(75)
}
}
}
}
/**
* Snackbar are transient Notification control used to deliver information which can be timedout or
* can be cleared by user pressing the CTA or dismiss icon. Snackbar is rendered using [SnackbarMetadata]
* which saves all the information about it. Snackbar shows one message at a time and uses a [SnackbarState]
* to save all the requests. Multiple styles of Snackbar are supported using [SnackbarStyle].
*
* @param snackbarState Queue to store all the Notification requests.
* @param modifier Optional modifier to be applied to Snackbar.
* @param snackbarTokens Optional Tokens to redesign Snackbar.
*/
@Composable
fun Snackbar(
snackbarState: SnackbarState,
modifier: Modifier = Modifier,
snackbarTokens: SnackBarTokens? = null
) {
val metadata: SnackbarMetadata = snackbarState.currentSnackbar ?: return
val themeID =
FluentTheme.themeID //Adding This only for recomposition in case of Token Updates. Unused otherwise.
val token = snackbarTokens
?: FluentTheme.controlTokens.tokens[ControlTokens.ControlType.SnackbarControlType] as SnackBarTokens
val snackBarInfo = SnackBarInfo(metadata.style, !metadata.subTitle.isNullOrBlank())
NotificationContainer(
notificationMetadata = metadata,
hasIcon = metadata.icon != null,
hasAction = metadata.actionText != null,
duration = metadata.duration
) { alpha, scale ->
Row(
modifier
.graphicsLayer(scaleX = scale.value, scaleY = scale.value, alpha = alpha.value)
.padding(horizontal = 16.dp)
.defaultMinSize(minHeight = 52.dp)
.fillMaxWidth()
.clip(RoundedCornerShape(8.dp))
.background(token.backgroundBrush(snackBarInfo))
.semantics {
liveRegion = LiveRegionMode.Polite
}
.testTag(SNACK_BAR),
verticalAlignment = Alignment.CenterVertically
) {
if (metadata.icon != null && metadata.icon.isIconAvailable()) {
Box(
modifier = Modifier
.testTag(SNACK_BAR_ICON)
.then(
if (metadata.icon.onClick != null) {
Modifier.clickable(
interactionSource = remember { MutableInteractionSource() },
indication = rememberRipple(),
enabled = true,
role = Role.Image,
onClick = metadata.icon.onClick!!
)
} else Modifier
)
) {
Icon(
metadata.icon,
modifier = Modifier
.padding(start = 16.dp, top = 12.dp, bottom = 12.dp)
.size(token.leftIconSize(snackBarInfo)),
tint = token.iconColor(snackBarInfo)
)
}
}
if (metadata.subTitle.isNullOrBlank()) {
BasicText(
text = metadata.message,
modifier = Modifier
.weight(1F)
.padding(start = 16.dp, top = 12.dp, bottom = 12.dp),
style = token.titleTypography(snackBarInfo)
)
} else {
Column(
Modifier
.weight(1F)
.padding(start = 16.dp, top = 12.dp, bottom = 12.dp)
) {
BasicText(
text = metadata.message,
style = token.titleTypography(snackBarInfo)
)
BasicText(
text = metadata.subTitle,
style = token.subtitleTypography(snackBarInfo),
modifier = Modifier.testTag(SNACK_BAR_SUBTITLE)
)
}
}
if (metadata.actionText != null) {
Button(
onClick = { metadata.clicked() },
modifier = Modifier
.testTag(SNACK_BAR_ACTION_BUTTON)
.then(
if (!metadata.enableDismiss)
Modifier.padding(horizontal = 16.dp, vertical = 12.dp)
else
Modifier.padding(start = 16.dp, top = 12.dp, bottom = 12.dp)
),
text = metadata.actionText,
style = ButtonStyle.TextButton,
size = ButtonSize.Small,
buttonTokens = object : ButtonTokens() {
@Composable
override fun textColor(buttonInfo: ButtonInfo): StateColor {
return StateColor(
rest = token.iconColor(snackBarInfo),
pressed = token.iconColor(snackBarInfo),
focused = token.iconColor(snackBarInfo),
)
}
}
)
}
if (metadata.enableDismiss) {
Box(
modifier = Modifier
.clickable(
interactionSource = remember { MutableInteractionSource() },
indication = rememberRipple(),
enabled = true,
role = Role.Image,
onClickLabel = "Dismiss",
onClick = { metadata.dismiss() }
)
.testTag(SNACK_BAR_DISMISS_BUTTON)
) {
Icon(
Icons.Filled.Close,
"Dismiss",
modifier = Modifier
.padding(start = 12.dp, top = 12.dp, bottom = 12.dp, end = 16.dp)
.size(token.dismissIconSize(snackBarInfo)),
tint = token.iconColor(snackBarInfo)
)
}
}
}
}
}