How skydoves/balloon works
Project type and purpose
• This is an Android multi‐module library project delivering a tooltip/popup component (“Balloon”) and Jetpack Compose integration (“balloon‐compose”), plus sample/demo apps and benchmarks. The modules are:
• balloon (core Android library)
• balloon‐compose (Jetpack Compose extension)
• app (Android demo showcasing usage)
• benchmark‐app & benchmark (micro‐benchmark apps & generators)
• buildSrc, scripts (build configuration & publishing)
File structure
• Top‐level: Gradle settings, CI workflows, lint/spotless, scripts, buildSrc.
• Each Android module (/balloon, /balloon-compose, /app, /benchmark-app, /benchmark) follows standard src/main/{kotlin,res}.
• Dependencies: app & benchmark-app depend on balloon & balloon-compose; buildSrc provides shared version management.
• CI: .github/workflows for Android CI, publishing, docs.
Key architectural insights from README
• Core module provides a Builder‐pattern API for tooltips.
• Compose module wraps core as composables.
• Demo & benchmarks illustrate integration points and performance testing.
• Uses lifecycle owners, factory pattern for lazy balloon creation.
a. Main components:
• Gradle Build System (settings.gradle.kts, buildSrc, scripts)
• Core Library Module (“balloon”)
• Compose Extension Module (“balloon-compose”)
• Demo App Module (“app”)
• Benchmark Modules (“benchmark-app”, “benchmark”)
• CI/CD Pipeline (GitHub Actions)
• Publishing (Maven Central)
b. Relationships/interactions:
• app → balloon & balloon-compose (implements tooltips)
• benchmark-app & benchmark → balloon (measures performance)
• buildSrc → all modules (provides versions configuration)
• CI workflows → triggers build/test/publish, runs on commit → module tests → publish artifacts
• Maven Central ← balloon & balloon-compose (artifacts published)
c. Architectural patterns:
• Modularization: separate core, extensions, demos, benchmarks
• Builder & Factory patterns in code (Balloon.Builder, Balloon.Factory)
• Layered build configuration (buildSrc for shared versions)
d. Technologies/frameworks:
• Kotlin & Android SDK
• Jetpack Compose
• Gradle Kotlin DSL & Version Catalog (libs.versions.toml)
• GitHub Actions for CI/CD
• Maven Central for artifact distribution