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

commit a330c0d3bcdd41326f37968a60e6084ad4a2e32c
Author: Chet Haase <chet@google.com>
Date: Wed Jul 05 07:26:46 2023

Convert APIs using PointF to use Float instead

PointF is a convenient mechanism for passing around x.y values
representing 2D points. But there are downsides, including:
- Converting to PointF: You may not have the data in PointF form
to begin with, so using an API which takes PointF requires converting
the data to that form (including allocating a PointF object every time)
- Mutability: Point structures can be mutated internally, causing
unpredictability in what that mutation means. Should the library
react to those changes? Ignore them? Do defensive copies (requiring
even more allocations)? Using primitive types like Float make the
behavior more obvious (by making the data inherently immutable).
- Allocations: Whenever we use object types, there are necessarily
allocations on the Java heap for them. This puts pressure on the GC
at both allocation and collection time. Given the amount of points
being passed around (especially at morph creation time, when curves
are being split and created), this causes a lot of PointF objects to
be allocated (even temporarily). Using Float avoids that problem.

Also fixed bug with unclosed paths causing discontinuity at the
start/end point.

Bug: 276466399
Bug: 290254314
Test: integration and unit tests pass
Relnote: PointF parameters changed to Float pairs
Change-Id: Id4705d27c7be31b26ade8186b99fffe2e2f8450e

M graphics/graphics-shapes/api/current.txt
M graphics/graphics-shapes/api/restricted_current.txt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/CubicShapeTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/CubicTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/PolygonMeasureTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/PolygonTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/RoundedPolygonTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/ShapesTest.kt
M graphics/graphics-shapes/src/androidTest/java/androidx/graphics/shapes/TestUtils.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/Cubic.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/CubicShape.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/FeatureMapping.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/FloatMapping.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/Morph.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/PolygonMeasure.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/RoundedPolygon.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/Shapes.kt
M graphics/graphics-shapes/src/main/java/androidx/graphics/shapes/Utils.kt
M graphics/integration-tests/testapp-compose/src/main/java/androidx/graphics/shapes/testcompose/DebugDraw.kt
M graphics/integration-tests/testapp-compose/src/main/java/androidx/graphics/shapes/testcompose/ShapeEditor.kt
M graphics/integration-tests/testapp/src/main/java/androidx/graphics/shapes/test/MaterialShapes.kt

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

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.

PointF was the main (possibly only) mutability issue, marking this as fixed

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

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

androidx.graphics:graphics-shapes:1.0.0-alpha04

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.

wa...@gmail.com <wa...@gmail.com> #6Mar 10, 2025 10:21PM

The main suggestion was to make the api flexible so a custom dismiss duration could be passed in when isPersistent = false and no extra logic is required. Any plans on providing that flexibility in the TooltipBox?

Message last modified on Mar 11, 2025 01:18AM