CMPToast

KO | EN

gitlite — search

#python #hacktoberfest #ai #android #machine-learning #rust #linux #docker #windows #awesome #kubernetes #vue #security #mcp

(★ 110)

No description available.

파일 탐색기

최종 버전 다운로드 (.zip)

- CMPToast-Banner.png
- ToastLibDemoVideo.gif
- build.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - Info.plist
  - iosApp.swift
- - project.pbxproj
build.gradle.kts
CODE_OF_CONDUCT.md
gradle.properties
gradlew
gradlew.bat
LICENSE.txt
README.md
settings.gradle.kts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Maven Central](https://img.shields.io/maven-central/v/network.chaintech/cmptoast.svg)](https://central.sonatype.com/artifact/network.chaintech/cmptoast)
[![Kotlin](https://img.shields.io/badge/kotlin-v2.2.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![Compose Multiplatform](https://img.shields.io/badge/Compose%20Multiplatform-v1.9.0-blue)](https://github.com/JetBrains/compose-multiplatform)
[![License](https://img.shields.io/github/license/Chaintech-Network/CMPToast)](http://www.apache.org/licenses/LICENSE-2.0)

![badge-android](http://img.shields.io/badge/platform-android-3DDC84.svg?style=flat)
![badge-ios](http://img.shields.io/badge/platform-ios-FF375F.svg?style=flat)
![badge-desktop](http://img.shields.io/badge/platform-desktop-FF9500.svg?style=flat)
![badge-web](https://img.shields.io/badge/platform-web-33ceff.svg?style=flat)

# CMPToast - Toasts for Compose Multiplatform

🍞️ CMPToast is a lightweight and easy-to-use library for displaying toast messages in Compose Multiplatform projects.

## ✨ Features

- **Cross-platform support**: Works seamlessly on Android and iOS.
- **Composable API**: Designed to integrate naturally into Jetpack Compose.
- **Customizable**: Customize your toast message with text, duration, and appearance.

## 📦 Installation

To use CMPToast in your Compose Multiplatform project, add the following dependency to your `build.gradle.kts`:

```kotlin
commonMain.dependencies {
  implementation("network.chaintech:cmptoast:1.0.8")
}
```

Note : Create an Application Class and add the following line (Otherwise you might face context error):

```kotlin
class MyApplication : Application() {
  override fun onCreate() {
    super.onCreate()
    multiplatform.network.cmptoast.AppContext.apply { set(applicationContext) }
  }
}
```

Also if you are getting Manifest Merger Failed issue, add the following to your Android Manifest file:

```kotlin
tools:replace="android:name"
```
```kotlin
tools:replace="android:allowBackup"
```

## 🚀 Usage

### Basic Toast

To display a simple toast:

```kotlin
showToast(
 message = "This is a Toast"
)
```

### Important : Desktop and Web Support

To display a toast add the `ToastHost` to your main composable inside your wasmJs or jvm target:
Checkout the sample app for implementation

```kotlin
// For jvmMain target (..jvmMain/main.kt)
fun main() = application {
  Window(
    title = "CMPToast Demo",
    state = rememberWindowState(width = 800.dp, height = 600.dp),
    onCloseRequest = ::exitApplication,
  ) {
    window.minimumSize = Dimension(150, 150)
    App()

ToastHost() // *** Important : Include this line to show the ToastHost
  }
}

// For wasmJs target (..wasmJsMain/main.kt)
@OptIn(ExperimentalComposeUiApi::class)
fun main() {
  ComposeViewport(document.body!!) {
    App()

ToastHost() // *** Important : Include this line to show the ToastHost
 }
}
```

## 🎥 Demo

Watch the demo below to see CMPToast in action:

## 🎨 Customisation

### ⏳ Short Toast

To show a short-duration toast:

```kotlin
showToast(
  message = "This is Short Toast",
  backgroundColor = Color.White,
  textColor = Color.Black,
  duration = ToastDuration.Short
)
```

### ⏱️ Long Toast

To show a long-duration toast:

```kotlin
showToast(
  message = "This is Long Toast",
  backgroundColor = Color.White,
  textColor = Color.Black,
  duration = ToastDuration.Long
)
```

### 📍 Top Toast

To show toast at top of the screen:

```kotlin
showToast(
  message = "This is Top Toast",
  backgroundColor = Color.White,
  textColor = Color.Black,
  gravity = ToastGravity.Top
)
```

### 🎯 Center Toast

To show toast at center of the screen:

```kotlin
showToast(
  message = "This is Center Toast",
  backgroundColor = Color.White,
  textColor = Color.Black,
  gravity = ToastGravity.Center
)
```

### 🎨 Colored Toast

To show a colored toast:

```kotlin
showToast(
  message = "This is Colored Toast",
  backgroundColor = Color(0xFF27AD9D)
)
```

### 🎨 Icon Toast

To show a toast with icon:

```kotlin
val resource = Res.drawable.ic_profile // Profile Icon
val iconBitmap = resource.let { imageResource(it) }

showToast(
  message = "This is Icon Toast",
  backgroundColor = Color.White,
  textColor = Color.Black,
  gravity = ToastGravity.Center,
  icon = iconBitmap,
  iconSizeDp = 20
)
```

### 🕰️ Custom Duration Toast

To show a toast with icon:

```kotlin
showToast(
 message = "This is Custom Duration Toast",
 backgroundColor = Color.White,
 textColor = Color.Black,
 duration = ToastDuration.CustomDuration(10) // Specify duration in seconds
)
```
Note : For Android custom duration won't work as it has default 2 duration(Duration.LONG and Duration.SHORT)

## ⚙️ Properties

| Property | Type | Description |
|---------------------|-----------------|----------------------------------------------------------|
| **message** | `String` | The message to be displayed in the toast. |
| **icon** | `ImageBitmap?` | Optional icon to be displayed alongside the message. |
| **iconSizeDp** | `Dp` | The size of the icon in dp. |
| **gravity** | `ToastGravity` | The position of the toast (e.g., Top, Center, Bottom). |
| **backgroundColor** | `Color` | The background color of the toast. |
| **textColor** | `Color` | The color of the message text. |
| **duration** | `ToastDuration` | The duration of the toast (Short or Long). |
| **padding** | `ToastPadding?` | Internal padding for the toast content. |
| **textSize** | `TextUnit` | The size of the text. |
| **topPadding** | `Int` | Padding between toast and top of the screen. |
| **bottomPadding** | `Int` | Padding between toast and bottom of the screen. |
| **cornerRadius** | `Int?` | For rounding the corners of the toast. |

## 🖥️ Platforms Supported

CMPToast currently supports the following platforms:

- **Android** 🤖
- **iOS** 🍎

## 📖 Detailed Explanation

For an in-depth guide and detailed explanation, check out our comprehensive Medium Blog Post.

[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@waghmaremayur855/cmptoast-toasts-for-compose-multiplatform-projects-db4a78f37dfe)

Stay connected and keep up with our latest innovations! 💼 Let's innovate together!

[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/showcase/mobile-innovation-network)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

CMPToast

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

CMPToast

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README