├── README.md
├── ToastHost.kt
└── LICENSE
/README.md:
--------------------------------------------------------------------------------
1 | # ComposeToast
2 |
3 | Animated Jetpack Compose replacement of android standard Toast messages
4 |
5 | Copy ToastHost.kt file to your repository and you are ready to engage!
6 |
7 | ```kotlin
8 | //Usage example
9 | val toastHostState = remember { ToastHostState() }
10 | val scope = rememberCoroutineScope()
11 |
12 | Button(
13 | onClick = {
14 | scope.launch {
15 | toastHostState.showToast(/*Your Visuals*/)
16 | }
17 | }
18 | ) {
19 | Text("Show Toast")
20 | }
21 |
22 | ToastHost(hostState = toastHostState)
23 | ```
24 |
25 | ## Note
26 | Also remember to add this dependencies to local build.gradle folder
27 | ```kotlin
28 | implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
29 | implementation("androidx.compose.ui:ui:1.4.0-alpha03")
30 | implementation("androidx.compose.material3:material3:1.1.0-alpha03")
31 | ```
32 |
33 | ## Find this repository useful? :heart:
34 | Support it by joining __[stargazers](https://github.com/t8rin/ComposeToast/stargazers)__ for this repository. :star:
35 | And __[follow](https://github.com/t8rin)__ me for my next creations! 🤩
36 |
37 | # License
38 | ```xml
39 | Designed and developed by 2023 T8RIN
40 |
41 | Licensed under the Apache License, Version 2.0 (the "License");
42 | you may not use this file except in compliance with the License.
43 | You may obtain a copy of the License at
44 |
45 | http://www.apache.org/licenses/LICENSE-2.0
46 |
47 | Unless required by applicable law or agreed to in writing, software
48 | distributed under the License is distributed on an "AS IS" BASIS,
49 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
50 | See the License for the specific language governing permissions and
51 | limitations under the License.
52 | ```
53 |
--------------------------------------------------------------------------------
/ToastHost.kt:
--------------------------------------------------------------------------------
1 | import androidx.annotation.FloatRange
2 | import androidx.compose.animation.*
3 | import androidx.compose.animation.core.tween
4 | import androidx.compose.foundation.layout.*
5 | import androidx.compose.material3.*
6 | import androidx.compose.runtime.*
7 | import androidx.compose.ui.Alignment
8 | import androidx.compose.ui.Modifier
9 | import androidx.compose.ui.draw.alpha
10 | import androidx.compose.ui.graphics.Color
11 | import androidx.compose.ui.graphics.Shape
12 | import androidx.compose.ui.graphics.toArgb
13 | import androidx.compose.ui.graphics.vector.ImageVector
14 | import androidx.compose.ui.platform.AccessibilityManager
15 | import androidx.compose.ui.platform.LocalAccessibilityManager
16 | import androidx.compose.ui.platform.LocalConfiguration
17 | import androidx.compose.ui.text.style.TextAlign
18 | import androidx.compose.ui.unit.dp
19 | import androidx.core.graphics.ColorUtils
20 | import kotlinx.coroutines.*
21 | import kotlinx.coroutines.sync.Mutex
22 | import kotlinx.coroutines.sync.withLock
23 | import kotlin.coroutines.resume
24 | import kotlin.math.min
25 |
26 |
27 | val LocalToastHostState =
28 | compositionLocalOf { error("ToastHostState not present") }
29 |
30 | @Composable
31 | fun rememberToastHostState() = remember { ToastHostState() }
32 |
33 | @OptIn(ExperimentalAnimationApi::class)
34 | @Composable
35 | fun ToastHost(
36 | hostState: ToastHostState = LocalToastHostState.current,
37 | modifier: Modifier = Modifier.fillMaxSize(),
38 | alignment: Alignment = Alignment.BottomCenter,
39 | toast: @Composable (ToastData) -> Unit = { Toast(it) }
40 | ) {
41 | val currentToastData = hostState.currentToastData
42 | val accessibilityManager = LocalAccessibilityManager.current
43 | LaunchedEffect(currentToastData) {
44 | if (currentToastData != null) {
45 | val duration = currentToastData.visuals.duration.toMillis(accessibilityManager)
46 | delay(duration)
47 | currentToastData.dismiss()
48 | }
49 | }
50 |
51 | AnimatedContent(
52 | targetState = currentToastData,
53 | transitionSpec = { ToastDefaults.transition }
54 | ) {
55 | Box(modifier = modifier) {
56 | Box(modifier = Modifier.align(alignment)) {
57 | it?.let { toast(it) }
58 | }
59 | }
60 | }
61 |
62 | }
63 |
64 | @Composable
65 | fun Toast(
66 | toastData: ToastData,
67 | modifier: Modifier = Modifier,
68 | shape: Shape = ToastDefaults.shape,
69 | containerColor: Color = ToastDefaults.color,
70 | contentColor: Color = ToastDefaults.contentColor,
71 | ) {
72 | val configuration = LocalConfiguration.current
73 | val sizeMin = min(configuration.screenWidthDp, configuration.screenHeightDp).dp
74 |
75 | Card(
76 | colors = CardDefaults.cardColors(
77 | containerColor = containerColor,
78 | contentColor = contentColor
79 | ),
80 | modifier = if (modifier != Modifier) modifier else
81 | Modifier
82 | .heightIn(min = 48.dp)
83 | .widthIn(min = 0.dp, max = (sizeMin * 0.7f))
84 | .padding(
85 | bottom = sizeMin * 0.2f,
86 | top = 24.dp,
87 | start = 12.dp,
88 | end = 12.dp
89 | )
90 | .imePadding()
91 | .systemBarsPadding()
92 | .alpha(0.95f),
93 | shape = shape
94 | ) {
95 | Row(
96 | Modifier.padding(15.dp),
97 | verticalAlignment = Alignment.CenterVertically,
98 | horizontalArrangement = Arrangement.Center
99 | ) {
100 | toastData.visuals.icon?.let { Icon(it, null) }
101 | Spacer(modifier = Modifier.size(8.dp))
102 | Text(
103 | style = MaterialTheme.typography.bodySmall,
104 | text = toastData.visuals.message,
105 | textAlign = TextAlign.Center,
106 | modifier = Modifier.padding(end = 5.dp)
107 | )
108 | }
109 | }
110 | }
111 |
112 | @Stable
113 | class ToastHostState {
114 |
115 | private val mutex = Mutex()
116 |
117 | var currentToastData by mutableStateOf(null)
118 | private set
119 |
120 | @OptIn(ExperimentalMaterial3Api::class)
121 | suspend fun showToast(
122 | message: String,
123 | icon: ImageVector? = null,
124 | duration: ToastDuration = ToastDuration.Short
125 | ) = showToast(ToastVisualsImpl(message, icon, duration))
126 |
127 |
128 | @ExperimentalMaterial3Api
129 | suspend fun showToast(visuals: ToastVisuals) = mutex.withLock {
130 | try {
131 | suspendCancellableCoroutine { continuation ->
132 | currentToastData = ToastDataImpl(visuals, continuation)
133 | }
134 | } finally {
135 | currentToastData = null
136 | }
137 | }
138 |
139 | private class ToastVisualsImpl(
140 | override val message: String,
141 | override val icon: ImageVector? = null,
142 | override val duration: ToastDuration
143 | ) : ToastVisuals {
144 |
145 | override fun equals(other: Any?): Boolean {
146 | if (this === other) return true
147 | if (other == null || this::class != other::class) return false
148 |
149 | other as ToastVisualsImpl
150 |
151 | if (message != other.message) return false
152 | if (icon != other.icon) return false
153 | if (duration != other.duration) return false
154 |
155 | return true
156 | }
157 |
158 | override fun hashCode(): Int {
159 | var result = message.hashCode()
160 | result = 31 * result + icon.hashCode()
161 | result = 31 * result + duration.hashCode()
162 | return result
163 | }
164 | }
165 |
166 | private class ToastDataImpl(
167 | override val visuals: ToastVisuals,
168 | private val continuation: CancellableContinuation
169 | ) : ToastData {
170 |
171 | override fun dismiss() {
172 | if (continuation.isActive) continuation.resume(Unit)
173 | }
174 |
175 | override fun equals(other: Any?): Boolean {
176 | if (this === other) return true
177 | if (other == null || this::class != other::class) return false
178 |
179 | other as ToastDataImpl
180 |
181 | if (visuals != other.visuals) return false
182 | if (continuation != other.continuation) return false
183 |
184 | return true
185 | }
186 |
187 | override fun hashCode(): Int {
188 | var result = visuals.hashCode()
189 | result = 31 * result + continuation.hashCode()
190 | return result
191 | }
192 | }
193 | }
194 |
195 | @Stable
196 | interface ToastData {
197 | val visuals: ToastVisuals
198 | fun dismiss()
199 | }
200 |
201 | @Stable
202 | interface ToastVisuals {
203 | val message: String
204 | val icon: ImageVector?
205 | val duration: ToastDuration
206 | }
207 |
208 | enum class ToastDuration { Short, Long }
209 |
210 | object ToastDefaults {
211 | @OptIn(ExperimentalAnimationApi::class)
212 | val transition: ContentTransform
213 | get() = fadeIn(tween(300)) + scaleIn(
214 | tween(500),
215 | transformOrigin = TransformOrigin(0.5f, 1f)
216 | ) + slideInVertically(
217 | tween(500)
218 | ) { it / 2 } with fadeOut(tween(250)) + slideOutVertically(tween(500)) { it / 2 } + scaleOut(
219 | tween(750),
220 | transformOrigin = TransformOrigin(0.5f, 1f)
221 | )
222 | val contentColor: Color @Composable get() = MaterialTheme.colorScheme.inverseOnSurface.harmonizeWithPrimary()
223 | val color: Color @Composable get() = MaterialTheme.colorScheme.inverseSurface.harmonizeWithPrimary()
224 | val shape: Shape @Composable get() = MaterialTheme.shapes.extraLarge
225 | }
226 |
227 | private fun ToastDuration.toMillis(
228 | accessibilityManager: AccessibilityManager?
229 | ): Long {
230 | val original = when (this) {
231 | ToastDuration.Long -> 6500L
232 | ToastDuration.Short -> 3500L
233 | }
234 | return accessibilityManager?.calculateRecommendedTimeoutMillis(
235 | original,
236 | containsIcons = true,
237 | containsText = true
238 | ) ?: original
239 | }
240 |
241 | private fun Color.blend(
242 | color: Color,
243 | @FloatRange(from = 0.0, to = 1.0) fraction: Float = 0.2f
244 | ): Color = Color(ColorUtils.blendARGB(this.toArgb(), color.toArgb(), fraction))
245 |
246 | @Composable
247 | private fun Color.harmonizeWithPrimary(
248 | @FloatRange(
249 | from = 0.0,
250 | to = 1.0
251 | ) fraction: Float = 0.2f
252 | ): Color = blend(MaterialTheme.colorScheme.primary, fraction)
253 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------