Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pierfrancescosoffritti/tap-target-compose
A Jetpack Compose implementation of Material Design tap targets, for feature discovery.
https://github.com/pierfrancescosoffritti/tap-target-compose
android android-library android-ui jetpack-compose onboarding taptargetview
Last synced: 12 days ago
JSON representation
A Jetpack Compose implementation of Material Design tap targets, for feature discovery.
- Host: GitHub
- URL: https://github.com/pierfrancescosoffritti/tap-target-compose
- Owner: PierfrancescoSoffritti
- License: mit
- Created: 2023-12-08T17:06:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-05T13:19:37.000Z (3 months ago)
- Last Synced: 2025-01-17T04:08:23.943Z (21 days ago)
- Topics: android, android-library, android-ui, jetpack-compose, onboarding, taptargetview
- Language: Kotlin
- Homepage:
- Size: 5.12 MB
- Stars: 61
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#### \
#### [:mega: Use AI to manage your app's reviews on Google Play :arrow_right:](https://playstorereply.com)
Increase your apps ratings. Engage with all users, no more unanswered reviews.
Save time and increase customer satisfaction.
#### \
# tap-target-compose
tap-target-compose is a Jetpack Compose implementation of the [Material Design tap targets](https://m1.material.io/growth-communications/feature-discovery.html#feature-discovery-design), used for feature discovery.
This library was inspired by its View counterpart, [TapTargetView](https://github.com/KeepSafe/TapTargetView).
| | |
| --- | --- |
|  | [](https://github.com/Pool-Of-Tears/GreenStash) |
# Sample app
This library comes with a sample app that shows examples of how to use it.
* [Click here to see the source code of the sample app](./sample-app/).
:eyes: If you want to know when a new release of the library is published: [watch this repository on GitHub](https://github.com/PierfrancescoSoffritti/tap-target-compose/watchers).
# Download
The Gradle dependency is available via [MavenCentral](https://repo1.maven.org/maven2/com/pierfrancescosoffritti/).
The minimum API level supported by this library is API 13.
Add this to your module level `build.gradle` file to start using the library.
```gradle
dependencies {
implementation "com.pierfrancescosoffritti.taptargetcompose:core:1.2.1"
}
```
# Quick start
In order to start using the library you need to wrap your composables in a TapTargetCoordinator
```kotlin
TapTargetCoordinator(showTapTargets = true, onComplete = {}) {
Surface {
Button(
onClick = { },
modifier = Modifier.tapTarget(
precedence = 0,
title = TextDefinition(
text = "Tap target title",
textStyle = MaterialTheme.typography.titleLarge,
fontWeight = FontWeight.Bold,
color = MaterialTheme.colorScheme.onSecondaryContainer
),
description = TextDefinition(
text = "Tap target description",
textStyle = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSecondaryContainer
),
tapTargetStyle = TapTargetStyle(
backgroundColor = MaterialTheme.colorScheme.secondaryContainer,
tapTargetHighlightColor = MaterialTheme.colorScheme.onSecondaryContainer,
backgroundAlpha = 1f,
),
),
) {
Text(text = "Click here")
}
}
}
```
You can also create a `TapTargetDefinition` and pass it to the modifier:
```kotlin
val tapTargetDefinition = TapTargetDefinition(
precedence = 1,
title = TextDefinition(
text = "Tap target title",
textStyle = MaterialTheme.typography.titleLarge,
fontWeight = FontWeight.Bold,
color = MaterialTheme.colorScheme.onSecondaryContainer
),
description = TextDefinition(
text = "Tap target description",
textStyle = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSecondaryContainer
),
tapTargetStyle = TapTargetStyle(
backgroundColor = MaterialTheme.colorScheme.secondaryContainer,
tapTargetHighlightColor = MaterialTheme.colorScheme.onSecondaryContainer,
backgroundAlpha = 1f,
),
)
TapTargetCoordinator(showTapTargets = true, onComplete = {}) {
Surface {
Button(
onClick = { },
modifier = Modifier.tapTarget(tapTargetDefinition),
) {
Text(text = "Click here")
}
}
}
```
The library supports chaining of multiple tap targets, but you can also show only one if that's what you need.
---
For any question feel free to [open an issue on the GitHub repository](https://github.com/PierfrancescoSoffritti/tap-target-compose/issues).