Interactive spotlight tutorials with type-safe targets, smart tooltip positioning, reactive state management, multiple concurrent tutorial configurations, and a clean flat API for highlighting UI elements and showing contextual tooltips.
A cross-platform spotlight tutorial system for Compose Multiplatform.
PiscesSpotlight is a Kotlin Multiplatform library that provides an elegant solution for implementing interactive user tutorials in Compose applications. The library enables developers to create step-by-step guides that highlight specific UI components and display contextual information through positioned tooltips.
Add PiscesSpotlight to your Compose Multiplatform project:
commonMain.dependencies {
implementation("io.github.xcodebn:pisces-spotlight:0.1.0")
}
For detailed installation instructions, see the library documentation.
import io.piscesbn.xcodebn.piscespotlight.spotlight.*
// Define targets
data object LoginButton : SpotlightTarget
// Configure tutorial
@Composable
fun App {
PiscesSpotlightContainer(
tutorials = listOf(
PiscesTutorialConfig(
id = ,
steps = listOf(
SpotlightStep(
LoginButton,
,
)
)
)
),
onTutorialComplete = { id ->
println()
}
) {
Button(
onClick = { },
modifier = Modifier.piscesSpotlightTarget(LoginButton)
) {
Text()
}
}
}
piscespotlight/
├── spotlight/ # Library module
│ ├── src/
│ │ └── commonMain/
│ │ └── kotlin/
│ │ └── io/piscesbn/xcodebn/piscespotlight/
│ │ ├── PiscesSpotlight.kt
│ │ ├── SpotlightStep.kt
│ │ └── SpotlightTarget.kt
│ ├── build.gradle.kts
│ └── README.md # Comprehensive library documentation
├── demo/ # Demo application
│ └── src/
│ └── commonMain/
│ └── kotlin/
│ └── io/piscesbn/xcodebn/piscespotlight/
│ ├── App.kt
│ └── DemoTargets.kt
└── build.gradle.kts
spotlight/README.mddemo/README.md# Build all targets
./gradlew build
# Build library only
./gradlew :spotlight:build
# Build demo application
./gradlew :demo:build
# Publish to Maven Local
./gradlew :spotlight:publishToMavenLocal
# Run tests
./gradlew test
The demo module contains a fully functional demo showcasing the library's capabilities. The demo simulates a PDF summarizer application with a comprehensive 7-step onboarding tutorial demonstrating real-world integration patterns.
To run the demo:
# Android
./gradlew :demo:installDebug
# iOS (macOS only)
./gradlew :demo:iosSimulatorArm64Test
See demo/README.md for detailed demo documentation.
Contributions are welcome. Please follow these guidelines:
git checkout -b feature/your-feature)git commit -am 'Add new feature')git push origin feature/your-feature)This project uses Semantic Versioning. Version history:
Copyright 2025 Hassan Bazzoun
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
See the LICENSE file for details.
Hassan Bazzoun
For bug reports and feature requests, please use the GitHub issue tracker.
For questions and discussions, please use GitHub Discussions.
| Platform | Status | Notes |
|---|
| Android | Supported | API 24+ |
| iOS | Supported | arm64, simulator arm64 |
| Desktop (JVM) | Supported | Compose for Desktop |
| Web | Planned | Future release |
Surfaced from shared tags and platforms — no rankings paid for.