Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raheemadamboev/timer-flow
⏳️ Light library that gives you timer functionality and exposes Kotlin Flow
https://github.com/raheemadamboev/timer-flow
android android-library kotlin kotlin-coroutines kotlin-flows timer timer-flow timer-library
Last synced: 3 months ago
JSON representation
⏳️ Light library that gives you timer functionality and exposes Kotlin Flow
- Host: GitHub
- URL: https://github.com/raheemadamboev/timer-flow
- Owner: raheemadamboev
- License: apache-2.0
- Created: 2022-07-24T16:02:03.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-29T14:36:21.000Z (almost 2 years ago)
- Last Synced: 2024-01-17T02:32:04.162Z (5 months ago)
- Topics: android, android-library, kotlin, kotlin-coroutines, kotlin-flows, timer, timer-flow, timer-library
- Language: Kotlin
- Homepage:
- Size: 5.11 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-list - raheemadamboev/timer-flow - ⏳️ Light library that gives you timer functionality and exposes Kotlin Flow (Kotlin)
README
Timer Flow
⏳️ Light library to use Timer in Android. The library is implemented via Kotlin Coroutines and Kotlin Flows.
# Setup
Add it in your root **build.gradle** at the end of repositories:
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
Include below dependency in build.gradle of application and sync it:
```groovy
implementation 'com.github.raheemadamboev:timer-flow:1.0.2'
```
# Implementation
**Create an object of Timer:**
```kotlin
val timer = Timer()
```
**Set timer duration in milliseconds (default: 10 000):**
```kotlin
timer.timerDuration = 5_000L
```
**Start timer:**
```kotlin
timer.start()
```
**Observe time of timer:**
```kotlin
lifecycleScope.launch {
timer.time.collectLatest { time ->
// update UI, do something
println(time.toString())
}
}
```
**Pause timer:**
```kotlin
timer.pause()
```
_If you pause timer, do not forget to stop() it. Otherwise, it runs forever._
**Resume timer:**
```kotlin
timer.resume()
```
**Reset timer:**
```kotlin
timer.reset()
```
**Set checkpoint time (default: 3 000) that you will get notified when it is reached. It is implemented via Kotlin Channel and received as Kotlin Flow. So you will only get notified once:**
```kotlin
timer.timerCheckpoint = 2_500L
lifecycleScope.launch {
timer.event.collectLatest { event ->
when(event) {
Started -> Unit // timer started
Checkpoint -> Unit // checkpoint reached
Finished -> Unit // timer finished naturally, not programmatically
}
}
}
```
**Observe timer states. It is implemented via Kotlin StateFlow so you always get the current timer state:**
```kotlin
lifecycleScope.launch {
timer.state.collectLatest { state ->
when(state) {
Idle -> Unit // timer is in idle position, not running
Ticking -> Unit // timer is ticking, running
Paused -> Unit // timer is paused, not running
Finished -> Unit // timer is finished naturally, not programmatically finished, not running
Stopped -> Unit // timer is stoped programmatically by calling stop() function, not running
}
}
}
```
**After finished using Timer, please do not forget to stop(). Otherwise, it won't get garbage collected!**
```kotlin
timer.stop()
```
# Demo
Very simple Jetpack Compose demo. Download demo
# Projects using this library
**GoTest** 150 000+ downloads in Google Play Store
**Buxgalteriya schyotlar rejasi** 20 000+ downloads in Google Play Store
**Irregular Verbs** 20 000+ downloads in Google Play Store
# License
```xml
Designed and developed by raheemadamboev (Raheem) 2022.
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.
```