Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erolaksoy/compose-impression
A library provides a way to track impressions of items in a lazy list with Jetpack Compose.
https://github.com/erolaksoy/compose-impression
android android-library compose impression jetpack-compose jetpack-compose-library jetpack-compose-tutorial lazycolumn lazyrow mvvm-android
Last synced: 3 months ago
JSON representation
A library provides a way to track impressions of items in a lazy list with Jetpack Compose.
- Host: GitHub
- URL: https://github.com/erolaksoy/compose-impression
- Owner: erolaksoy
- License: apache-2.0
- Created: 2023-06-06T17:49:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-06T22:55:26.000Z (11 months ago)
- Last Synced: 2024-08-01T19:52:43.371Z (6 months ago)
- Topics: android, android-library, compose, impression, jetpack-compose, jetpack-compose-library, jetpack-compose-tutorial, lazycolumn, lazyrow, mvvm-android
- Language: Kotlin
- Homepage:
- Size: 2.17 MB
- Stars: 47
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - erolaksoy/compose-impression - A library provides a way to track impressions of items in a lazy list with Jetpack Compose. (Kotlin)
README
# Compose Impression
This library provides a way to track whether items appear on the screen in lazy lists.
| 
| 
|
| --------------------------------------------------- | ------------------------------------------------- |
| Lazy Column | Lazy Row |
## Usage
To use the impression, first create an `ImpressionState` with rememberImpressionState. Then, use the impression modifier to track impressions for items in your list.
⚠️ The item key you use in the lazy list has to be the same as the key you give to the impression modifier.
```kotlin
val lazyListState = rememberLazyListState()
val impressionState = rememberImpressionState(lazyListState)
LaunchedEffect(Unit) {
impressionState.seenEvent.collectLatest {
// collect impression events
}
}
LazyRow(
modifier = modifier.fillMaxSize(),
state = lazyListState,
contentPadding = PaddingValues(16.dp),
horizontalArrangement = Arrangement.spacedBy(12.dp)
) {
items(list, key = { it }) {
CardItem(
key = it,
modifier = Modifier
.width(250.dp)
.height(120.dp)
.impression(it, impressionState),
)
}
}
```
or
```kotlin
val lazyListState = rememberLazyListState()
val impressionState = rememberImpressionState(lazyListState)
LazyRow(
modifier = modifier.fillMaxSize(),
state = lazyListState,
contentPadding = PaddingValues(16.dp),
horizontalArrangement = Arrangement.spacedBy(12.dp)
) {
items(list, key = { it }) {
CardItem(
key = it,
modifier = Modifier
.width(250.dp)
.height(120.dp)
.impression(
key = it,
impressionState = impressionState,
onImpressionHappened = {
// collect impression event
}
),
)
}
}
```
## Validators
The `VisibilityPercentImpressionValidator` validates impressions based on the visibility percentage of an item.
```kotlin
val impressionState = rememberImpressionState(lazyListState) {
addValidator(VisibilityPercentImpressionValidator(0.5f)) // set the visibility percentage threshold to 50%
}
```
With this configuration, when an item is 50% visible, the impression will be validated and happened.
You can create your own validator by extending from ImpressionValidator.
## Including in your project
[](https://github.com/erolaksoy/compose-impression#including-in-your-project)
1. Add the JitPack repository to your project-level `build.gradle` file:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
1. Add the dependency to your app-level `build.gradle` file:
```
dependencies {
implementation 'com.github.erolaksoy:compose-impression:0.1.1'
}
```
1. Sync your project with Gradle files.
## License
```xml
Copyright 2023 Erol Aksoy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```