
Automates library release and distribution: converts README into a homepage, publishes API docs and interactive web demo, builds downloadable sample app binaries and CI/CD pipeline.
A full-screen media viewer library for Compose Multiplatform that enables displaying images and videos with pinch-to-zoom, panning, and swipe-to-dismiss support across Android, iOS, Desktop/JVM, and Web/WASM.
Key Features:
| Capability | Android | iOS | Desktop (JVM) | Web (WASM) |
|---|---|---|---|---|
| Image Viewer | ✅ | ✅ | ✅ | ✅ |
| Video Viewer | ✅ | ✅ | ✅* | ✅ |
| Pinch-to-zoom / Pan | ✅ | ✅ | ✅ | ✅ |
| Swipe Navigation | ✅ | ✅ | ✅ | ✅ |
| Keyboard Listeners | ❌ | ❌ | ✅ | ✅ |
*Desktop video playback relies on native VLC libraries (libvlc). Host machines must have VLC Media Player installed (brew install --cask vlc on macOS, sudo apt install vlc libvlc-dev on Linux). If VLC is not installed, the viewer displays an in-app notice with a retry option.
Add the dependency to your Compose Multiplatform project:
Option A — Version catalog (recommended)
gradle/libs.versions.toml:[versions]
cmpMediaviewer = "0.0.3"
[libraries]
cmp-mediaviewer = { module = "io.github.aryapreetam:cmp-mediaviewer", version.ref = "cmpMediaviewer" }build.gradle.kts:kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation(libs.cmp.mediaviewer)
}
}
}
}Option B — Direct dependency
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("io.github.aryapreetam:cmp-mediaviewer:0.0.3")
}
}
}
}To open the full-screen media viewer component:
import io.github.aryapreetam.cmpmediaviewer.MediaViewer
import io.github.aryapreetam.cmpmediaviewer.model.MediaItem
@Composable
fun MyMediaScreen() {
var showViewer by remember { mutableStateOf(false) }
Column(modifier = Modifier.fillMaxSize()) {
Button(onClick = { showViewer = true }) {
Text("Open Media Viewer")
}
if (showViewer) {
MediaViewer(
items = listOf(
MediaItem.image(id = "1", url = "https://example.com/photo.jpg", title = "Nature Photo"),
MediaItem.video(id = "2", url = "https://example.com/clip.mp4", title = "Promo Video")
),
initialIndex = 0,
onDismiss = { showViewer = false },
onPageChanged = { index -> println("Viewing index: $index") }
)
}
}
}Download and try the sample app on your platform without building from source:
| Platform | Download Link |
|---|---|
| 🍏 macOS (Intel) | |
| 🍎 macOS (Apple Silicon) | |
| 🪟 Windows | |
| 🐧 Linux | |
| 🤖 Android | |
| 🌐 Web (Wasm) | |
| iOS Simulator |
For instructions on how to install and run the pre-built executables or build and run the sample application from source code, please refer to the How to Run the Sample App guide.
MIT License © 2025 aryapreetam and contributors. See LICENSE for details.
See CONTRIBUTING.md for detailed contribution guidelines.
A full-screen media viewer library for Compose Multiplatform that enables displaying images and videos with pinch-to-zoom, panning, and swipe-to-dismiss support across Android, iOS, Desktop/JVM, and Web/WASM.
Key Features:
| Capability | Android | iOS | Desktop (JVM) | Web (WASM) |
|---|---|---|---|---|
| Image Viewer | ✅ | ✅ | ✅ | ✅ |
| Video Viewer | ✅ | ✅ | ✅* | ✅ |
| Pinch-to-zoom / Pan | ✅ | ✅ | ✅ | ✅ |
| Swipe Navigation | ✅ | ✅ | ✅ | ✅ |
| Keyboard Listeners | ❌ | ❌ | ✅ | ✅ |
*Desktop video playback relies on native VLC libraries (libvlc). Host machines must have VLC Media Player installed (brew install --cask vlc on macOS, sudo apt install vlc libvlc-dev on Linux). If VLC is not installed, the viewer displays an in-app notice with a retry option.
Add the dependency to your Compose Multiplatform project:
Option A — Version catalog (recommended)
gradle/libs.versions.toml:[versions]
cmpMediaviewer = "0.0.3"
[libraries]
cmp-mediaviewer = { module = "io.github.aryapreetam:cmp-mediaviewer", version.ref = "cmpMediaviewer" }build.gradle.kts:kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation(libs.cmp.mediaviewer)
}
}
}
}Option B — Direct dependency
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("io.github.aryapreetam:cmp-mediaviewer:0.0.3")
}
}
}
}To open the full-screen media viewer component:
import io.github.aryapreetam.cmpmediaviewer.MediaViewer
import io.github.aryapreetam.cmpmediaviewer.model.MediaItem
@Composable
fun MyMediaScreen() {
var showViewer by remember { mutableStateOf(false) }
Column(modifier = Modifier.fillMaxSize()) {
Button(onClick = { showViewer = true }) {
Text("Open Media Viewer")
}
if (showViewer) {
MediaViewer(
items = listOf(
MediaItem.image(id = "1", url = "https://example.com/photo.jpg", title = "Nature Photo"),
MediaItem.video(id = "2", url = "https://example.com/clip.mp4", title = "Promo Video")
),
initialIndex = 0,
onDismiss = { showViewer = false },
onPageChanged = { index -> println("Viewing index: $index") }
)
}
}
}Download and try the sample app on your platform without building from source:
| Platform | Download Link |
|---|---|
| 🍏 macOS (Intel) | |
| 🍎 macOS (Apple Silicon) | |
| 🪟 Windows | |
| 🐧 Linux | |
| 🤖 Android | |
| 🌐 Web (Wasm) | |
| iOS Simulator |
For instructions on how to install and run the pre-built executables or build and run the sample application from source code, please refer to the How to Run the Sample App guide.
MIT License © 2025 aryapreetam and contributors. See LICENSE for details.
See CONTRIBUTING.md for detailed contribution guidelines.