ktoast

1.0.5indexed

Enhances toast notifications with seamless integration across mobile, web, and desktop platforms using Compose Multiplatform, offering versatile and customizable message displays.

AndroidJVMNativeWasm·tarifchakder/ktoast

Stars

—

Used by

dependents

—

Health

/ 100

🔔 KToast

badge-android badge-ios badge-desktop badge-js

✨ Overview

KToast is a lightweight toast/notice library built with Kotlin Multiplatform and Compose Multiplatform. It provides a simple, unified API to show toasts across Android, iOS, Desktop (JVM), and Web/Wasm with sensible defaults and smooth transitions.

🖥️ Demo

Android	Desktop	Web	iOS

📦 Features

Cross-platform: Android, iOS, Desktop (JVM), Web/Wasm
Simple API: one ToastState you can pass around
Composable host: place it anywhere in your layout
Transitions: slide/fade presets via ToastDefaults
Works with your theme: drop into any Material setup

🧰 Stack

Language: Kotlin (Multiplatform)
UI: JetBrains Compose Multiplatform
Targets: Android, iOS (framework), Desktop (JVM), Wasm/JS (browser)
Build System: Gradle 8.13 (Wrapper)
Android Gradle Plugin with Compose; Kotlin 2.0.20; Compose MPP 1.7.0
Publishing: Maven Central via Gradle (maven-publish + Vanniktech plugin) and GitHub Actions

✅ Requirements

JDK 17 installed (library targets JVM 17; Android module compiles with Java 11 toolchain but JDK 17 is safe across the board)
Android Studio Giraffe+ / IntelliJ IDEA 2024.2+ recommended
Xcode 15+ for iOS build/run
Node.js is optional; Web/Wasm is built via Gradle (Webpack is configured by Kotlin plugin)
Operating systems: macOS for building iOS; any OS for Desktop/Android/Web

🚀 Installation (use as a dependency)

Add KToast to your multiplatform project from commonMain.

Gradle (Kotlin DSL)

kotlin {
    sourceSets {
        commonMain {
            dependencies {
                implementation("com.tarifchakder:ktoast:<latest>")
            }
        }
    }
}

Version Catalog

[versions]
toast = "1.0.5" # TODO: replace with the latest from Maven Central

[libraries]
k-toast = { module = "com.tarifchakder:ktoast", version.ref = "toast" }

🧪 Usage (basics)

// Create toast state
val toast = ToastState()

MaterialTheme {
    Box {
        ToastHost(
            modifier = Modifier.fillMaxSize().padding(20.dp),
            alignment = Alignment.BottomCenter,
            hostState = toast,
            transitionSpec = { ToastDefaults.SLIDE }
        )
    }
}

// Call it anywhere
toast.showToast("Hi this is a common toast")

🏃 Run the sample app (composeApp)

This repo includes a sample app to try the library on all targets.

Desktop (JVM):
- ./gradlew :composeApp:run

Notes:

For iOS build from Gradle, additional setup may be required; Xcode is the recommended runner.

🔧 Common scripts (Gradle tasks)

Build all: ./gradlew build
Check/verify: ./gradlew check
Run Desktop sample: ./gradlew :composeApp:run
Android build (sample): ./gradlew :composeApp:assembleDebug
Wasm dev server: ./gradlew :composeApp:wasmJsBrowserDevelopmentRun
Publish library to Maven Central (CI uses this): ./gradlew publishAllPublicationsToMavenCentralRepository
Generate docs (Dokka): ./gradlew :kmp-toast:dokkaHtml