https://github.com/adevintaspain/taggingviewer
Visualize live on-screen all the tagging that is occurring in your application
https://github.com/adevintaspain/taggingviewer
android debugging-tool events kotlin-android tagging tracking
Last synced: 4 months ago
JSON representation
Visualize live on-screen all the tagging that is occurring in your application
- Host: GitHub
- URL: https://github.com/adevintaspain/taggingviewer
- Owner: AdevintaSpain
- License: other
- Created: 2022-11-15T17:45:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-06T15:35:38.000Z (over 2 years ago)
- Last Synced: 2025-04-01T17:53:35.581Z (6 months ago)
- Topics: android, debugging-tool, events, kotlin-android, tagging, tracking
- Language: Kotlin
- Homepage:
- Size: 1020 KB
- Stars: 8
- Watchers: 21
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Tagging Viewer
[](LICENSE.md)
This simple library lets you visualize live on-screen all the tagging that is occurring in your application.
This helps debug your tagging implementation.
## Example
| Overlay | Detail |
|-------------------------------------------|--------------------------------------------|
| 
| 
|
# Download
```groovy
dependencies {
debugImplementation 'com.adevinta.android:tagging-viewer:+'
releaseImplementation 'com.adevinta.android:tagging-viewer-no-op:+'
}
```
(Check for latest version in GitHub releases)
## 1. Register trackings
```kotlin
class MyCustomTracker {
fun trackScreen(screenName: String) {
// Fabric, Firebase, etc...
TaggingViewer.tagScreen(screenName)
}
fun trackClick(clickName: String) {
// Fabric, Firebase, etc...
TaggingViewer.tagClick(clickName)
}
fun trackEvent(eventName: String) {
// Fabric, Firebase, etc...
TaggingViewer.tagEvent(eventkName)
}
}
```
## 2. Display trackings
Whenever you want to show the tracked information enable the overlay from any Activity:
```kotlin
TaggingViewer.enableOverlay(context)
```
Alternatively, you can open a detailed screen with all tracked events and their extra information:
```kotlin
TaggingViewer.showDetailedActivity(context)
```
## 3. Styling
We are definitely not designers but we try our best. If you don't feel comfortable with the proposed design you only have to override the
following colors in your app to make it beautiful and show your colleagues how much sense of art you do have!
```xml
#fff#C4FFFFFF#000
#89ffffff#89000000
#00000000#FFA000#303F9F
#388E3C#F1F1F1#B1B1B1
```
Remember: You just have to define the color with the same name in your app and you are done!
# Contributing
If you find it useful and need more features or want to improve it, feel free to send a PR!