[FC] Debounce clicks on buttons and clickable surfaces #6836
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package com.stripe.android.financialconnections.ui.components | ||
|
|
||
| import androidx.compose.foundation.Indication | ||
| import androidx.compose.foundation.LocalIndication | ||
| import androidx.compose.foundation.clickable | ||
| import androidx.compose.foundation.interaction.MutableInteractionSource | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.composed | ||
| import androidx.compose.ui.platform.debugInspectorInfo | ||
| import androidx.compose.ui.semantics.Role | ||
|
|
||
| /** | ||
| * A wrapper around [clickable] that prevents multiple clicks from being registered within a | ||
| * short time frame. | ||
| */ | ||
| internal interface MultipleEventsCutter { | ||
| fun processEvent(event: () -> Unit) | ||
|
|
||
| companion object | ||
|
There was a problem hiding this comment. This is very interesting syntax! |
||
| } | ||
|
|
||
| internal fun MultipleEventsCutter.Companion.get(): MultipleEventsCutter = | ||
| MultipleEventsCutterImpl() | ||
|
|
||
| private class MultipleEventsCutterImpl : MultipleEventsCutter { | ||
| private val now: Long | ||
| get() = System.currentTimeMillis() | ||
|
|
||
| private var lastEventTimeMs: Long = 0 | ||
|
|
||
| override fun processEvent(event: () -> Unit) { | ||
| if (now - lastEventTimeMs >= DEBOUNCE_MS) { | ||
| event.invoke() | ||
| } | ||
| lastEventTimeMs = now | ||
| } | ||
|
|
||
| companion object { | ||
| private const val DEBOUNCE_MS = 500L | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A wrapper around [clickable] that prevents multiple clicks from being registered within a | ||
| * short time frame. | ||
| */ | ||
| internal fun Modifier.clickableSingle( | ||
| enabled: Boolean = true, | ||
| onClickLabel: String? = null, | ||
| role: Role? = null, | ||
| onClick: () -> Unit | ||
|
|
||
| ) = composed( | ||
| inspectorInfo = debugInspectorInfo { | ||
| name = "clickable" | ||
| properties["enabled"] = enabled | ||
| properties["onClickLabel"] = onClickLabel | ||
| properties["role"] = role | ||
| properties["onClick"] = onClick | ||
| }, | ||
|
|
||
| factory = { | ||
| val multipleEventsCutter = remember { MultipleEventsCutter.get() } | ||
| Modifier.clickable( | ||
| interactionSource = remember { MutableInteractionSource() }, | ||
| indication = LocalIndication.current, | ||
| enabled = enabled, | ||
| onClickLabel = onClickLabel, | ||
| onClick = { multipleEventsCutter.processEvent { onClick() } }, | ||
| role = role, | ||
| ) | ||
| } | ||
| ) | ||
|
|
||
| /** | ||
| * A wrapper around [clickable] that prevents multiple clicks from being registered within a | ||
| * short time frame. | ||
| */ | ||
| internal fun Modifier.clickableSingle( | ||
| interactionSource: MutableInteractionSource, | ||
| indication: Indication?, | ||
| enabled: Boolean = true, | ||
| onClickLabel: String? = null, | ||
| role: Role? = null, | ||
| onClick: () -> Unit | ||
|
|
||
| ) = composed( | ||
| inspectorInfo = debugInspectorInfo { | ||
| name = "clickable" | ||
| properties["enabled"] = enabled | ||
| properties["onClickLabel"] = onClickLabel | ||
| properties["role"] = role | ||
| properties["onClick"] = onClick | ||
| }, | ||
|
|
||
| factory = { | ||
| val multipleEventsCutter = remember { MultipleEventsCutter.get() } | ||
| Modifier.clickable( | ||
| interactionSource = interactionSource, | ||
| indication = indication, | ||
| enabled = enabled, | ||
| onClickLabel = onClickLabel, | ||
| onClick = { multipleEventsCutter.processEvent { onClick() } }, | ||
| role = role, | ||
| ) | ||
| } | ||
| ) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we call this
MultipleEventsDebouncer? I haven't heard of the term Cutter before.