Tooltip API isn't flexible enough. [293939035]

Fixed

Feature Request

Status Update

No update yet.

Description

fr...@gmail.com

created issue #1

Jul 31, 2023 10:06PM

Jetpack Compose version: compose-bom:2023.05.01
Jetpack Compose component used: PlainTooltipBox and RichTooltipBox
Material3 version: 1.1.0
Android Studio Build: N/A
Kotlin version: N/A

I like the convenience of the PlainTooltipBox component, but unfortunately the API isn't flexible enough to be useable in its current state. The problem is that the plain tooltip hides after a very short delay (1.5 seconds), and there isn't an option to turn off the autohiding. This makes the component useless for longer tooltips. I need to show the user an explanatory tooltip of maybe 2 sentences after they click an info icon, but the very short delay isn't even close to long enough to read it. There's also RichTooltipBox, but it will only persist if you pass it an action.

Unfortunately everything is `internal` in the Tooltip class, so I can't override this behavior or customize the delay, so my only option is to copy the whole class so that I can modify it, or not use it at all.

I propose adding the following properties to the TooltipState constructors:
- `val autoHide: Boolean = true`
- `val autoHideDelay: Long = TooltipDuration` // In milliseconds

Thanks!

Comments

yu...@gmail.com <yu...@gmail.com> #2Aug 25, 2023 12:44AM

Project: platform/frameworks/support
Branch: androidx-main
Author: Louis Pullen-Freilich <lpf@google.com>
Link: https://android-review.googlesource.com/3328184

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling

Expand for full commit details

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling 
 
These APIs allow overscroll to have events dispatched to it by one component, and rendered in a separate component. 
 
Fixes: b/266550551 
Fixes: b/204650733 
Fixes: b/255554340 
Fixes: b/229537244 
Test: OverscrollTest 
Relnote: "Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling APIs - these APIs create a wrapped instance of the provided overscroll effect that doesn't draw / handle events respectively, which allows for rendering  overscroll in a separate component from the component that is dispatching events. For example, disabling drawing the overscroll inside a lazy list, and then drawing the overscroll separately on top / elsewhere." 
Change-Id: Idbb3d91546b49c1987a041f959bce4b2b09a9f61

Files:

M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/OverscrollDemo.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/OverscrollSample.kt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt

Hash: f64e25b7a473c757d080521e7dd97b3f6670f60d
Date: Fri Nov 01 18:43:56 2024

Message last modified on Aug 25, 2023 01:58AM

se...@google.com <se...@google.com> #3Aug 25, 2023 04:50PM

Reassigned to ke...@google.com.

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.foundation:foundation:1.8.0-alpha06
androidx.compose.foundation:foundation-android:1.8.0-alpha06
androidx.compose.foundation:foundation-jvmstubs:1.8.0-alpha06
androidx.compose.foundation:foundation-linuxx64stubs:1.8.0-alpha06

ke...@google.com <ke...@google.com> #4Aug 25, 2023 06:00PM

@comment#1 As José mentioned, you can make plain tooltips persistent now by passing in isPersistent = false to rememberTooltipState(). These changes might not be available yet in the current release, but it should be included in the next one. Thanks! Plain tooltip should be used for quick descriptions, if you have a lot of text that requires longer than 1.5 seconds to read please use rich tooltip and make it actionable.

@comment#2 Thank you for your suggestions!

I think this is a reasonable ask, will file a bug to address.
We recently merged a change to tooltips that exposes the PopupPositionProvider, you should be able to alter the actual position with this parameter.
You can use the focusable parameter to achieve this flow.
Dallas What do you think about exposing the maxWidth for Plain and Rich tooltips? From my understanding, this isn't something that we normally expose.
Yeah this is part of the Popup implementation. If you'd like to escalate you can file an accessibility bug with the wider compose team.
Yup, this is expected.
This is something that we're currently working on! No exact ETA, but it would be in M3.

Message last modified on Aug 28, 2023 06:55PM

ke...@google.com <ke...@google.com> Oct 17, 2023 06:37PM

Accepted by ke...@google.com.

ap...@google.com <ap...@google.com> #5Oct 20, 2023 04:37PM

Project: platform/frameworks/support
Branch: androidx-main

commit 6c66eb5e520994bf4f500731d2bc2e57081a89f0
Author: Kevin Truong <kevinctruong@google.com>
Date: Thu Oct 19 10:22:52 2023

[Tooltip] Adding tonalElevation and shadowElevation to APIs

Adding more flexibility to the component by allowing users to set the tonal and shadow elevation of the tooltip.
Also moving TooltipBox, PlainTooltip, and RichTooltip APIs back to experimental since they were accidentally released as stable.

Bug: 293939035
Test: N/A
Relnote: Adding tonalElevation and shadowElevation to tooltip APIs. Additionally, moving TooltipBox, PlainTooltip, and RichTooltip APIs back to experimental since they were accidentally released as stable.
Change-Id: If0f66a8ccc737a0c163fd2b2a890ce60ad3d5fe4

M compose/material3/material3/api/current.txt
M compose/material3/material3/api/restricted_current.txt
M compose/material3/material3/integration-tests/material3-demos/src/main/java/androidx/compose/material3/demos/TooltipDemo.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/Tooltip.kt

https://android-review.googlesource.com/2797918

ke...@google.com <ke...@google.com> Oct 20, 2023 04:53PM

Marked as fixed.

Issue 293939035