Multiplatform connectivity

What is it?

Multiplatform-connectivity is a small, lightweight library for Compose/Kotlin Multiplatform that monitors device connectivity.

Features

• Monitor connectivity updates in real time
• Simplified Online and Offline status changes
• Supports iOS and Android

Platform Support

Android	iOS	MacOS	Web	Linux	Windows
✅	✅	❌	❌	❌	❌

Installation

Add the dependency to your libraries.toml file:

[versions]
multiplaform-connectivity = "1.0.2"

[libraries]
multiplatform-connectivity = { module = "io.github.jerrya:multiplaform-connectivity", version.ref = "multiplaform-connectivity" }

Add the dependency to common and sync your project with Gradle:

kotlin {
    sourceSets {
        commonMain.dependencies {
          implementation(libs.multiplatform.connectivity)
        }
    }
}

Usage

Multiplatform-connectivity exposes a Flow that produces two states: Online and Offline.

To collect on the flow, first get the reference to the connectivity repository and launch the latestStatus flow in a coroutine scope.

import io.github.jerrya.connectivity.getConnectivity

viewModelScope.launch {
    val connectivity = getConnectivity()
    connectivity.latestStatus().collect {
        when (it) {
            is ConnectivityRepository.Status.Online -> {
                // You are online
            }
            is ConnectivityRepository.Status.Offline -> {
                // You are offline
            }
        }
    }
}

Notes

Roadmap of features: https://github.com/jerrya/multiplatform-connectivity/issues?q=is%3Aissue+is%3Aopen+label%3A%22enhancement%22

iOS

• There is a known issue with iOS Simulators not responding correctly to connectivity changes. I recommend using a physical iPhone device to test connectivity.