Feat: make tooltip position customizeable #175047
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a positionDelegate to the Tooltip widget, allowing for customizable tooltip positioning. The implementation is clean, adding the new property and integrating it into the existing layout logic. The changes are well-documented and include a new test case to verify the custom positioning behavior. My only suggestion is to add a dartpad example to the documentation to further improve usability for developers, as recommended by the Flutter style guide.
| /// A custom position delegate function for computing where the tooltip should be positioned. | ||
| /// | ||
| /// If provided, this function will be called instead of the default positioning logic | ||
| /// to determine where to place the tooltip relative to its target. | ||
| /// | ||
| /// This allows for custom positioning such as left/right positioning, or any other | ||
| /// arbitrary positioning logic. | ||
| /// | ||
| /// If null, the default positioning behavior is used (above or below the target). | ||
| final TooltipPositionDelegate? positionDelegate; |
There was a problem hiding this comment.
The documentation for the new positionDelegate property is clear and helpful. To further improve usability and align with the Flutter style guide, consider adding a dartpad example demonstrating its usage.1
This would provide developers with a runnable example of how to implement custom tooltip positioning, for instance, showing how to position the tooltip to the left or right of the target widget.
Style Guide References
Footnotes
-
The style guide recommends providing sample code using
{@tool dartpad}for runnable examples to help developers understand how to use new features. ↩
5bf2348 to
e79e955
Compare
QuncCccccc
left a comment
There was a problem hiding this comment.
Overall looks good! Thanks for your contribution:)!
| /// Signature for computing the position of a tooltip. | ||
| /// | ||
| /// The arguments are: | ||
| /// * `target`: The offset of the target the tooltip is positioned near in the global coordinate system. |
There was a problem hiding this comment.
Is this offset the center of the target? If so, we might want to clarify it in documentation.
There was a problem hiding this comment.
Updated the documentation to show, target is center of triggering widget.
| /// | ||
| /// The arguments are: | ||
| /// * `target`: The offset of the target the tooltip is positioned near in the global coordinate system. | ||
| /// * `size`: The size of the overlay in which the tooltip is being positioned. |
There was a problem hiding this comment.
Not sure if this would be helpful for users to calculate the offset. It's fine to me. Can we add one more parameter like "targetSize" to this callback? I think it would be helpful to calculate the tooltip position. For example, if we want the tooltip to show up on the upper right corner of the target, this parameter would be useful. WDYT:)? I think the target size info can be found in OverlayChildLayoutInfo.
There was a problem hiding this comment.
Yes, I don't think size will be useful, so replacing it with targetSize which as you said will help in aligning tooltip to different required position. Also updating test, such that it shows as an example for aligning to top right.
QuncCccccc
left a comment
There was a problem hiding this comment.
The linux analyzer shows some format issue. To fix, run dart format packages/flutter/lib/src/material/tooltip.dart
e79e955 to
410be52
Compare
QuncCccccc
left a comment
There was a problem hiding this comment.
LGTM with nits:) Thank you for your contribution!
| /// The arguments are: | ||
| /// * `target`: The center point of the target widget in the global coordinate system. | ||
| /// * `targetSize`: The size of the target widget that triggers the tooltip. | ||
| /// * `childSize`: The size of the tooltip itself. |
There was a problem hiding this comment.
how about just tooltipSize?
| layoutInfo.childPaintTransform, | ||
| layoutInfo.childSize.center(Offset.zero), | ||
| ); | ||
| final Size targetSize = layoutInfo.childSize; |
There was a problem hiding this comment.
just nit:
| final Size targetSize = layoutInfo.childSize; | |
| final Size tooltipSize = layoutInfo.childSize; |
9463fe8 to
8e16e20
Compare
dkwingsmt
left a comment
There was a problem hiding this comment.
Generally looking good.
| /// * `preferBelow`: Whether the tooltip prefers to be positioned below the target. | ||
| /// | ||
| /// Returns the offset from the top left of the overlay to the top left of the tooltip. | ||
| typedef TooltipPositionDelegate = |
There was a problem hiding this comment.
Do you think we might encounter new properties for this delegate in the future? Extending this parameter list will be breaking. What do you think of grouping them into a data class for extensibility? We might call it TooltipPositionContext and the delegate will just take one parameter.
There was a problem hiding this comment.
Yup, makes sense. Let me update this.
| required double verticalOffset, | ||
| required bool preferBelow, |
There was a problem hiding this comment.
I wonder if we can remove the values from Tooltip's parameter list. If the app provides a delegate they would know all information needed for this algorithm anyway.
There was a problem hiding this comment.
I don't know both verticalOffset and preferBelow are used when delegate is not given. So, I don't think we can remove these.
8e16e20 to
fae5799
Compare
|
autosubmit label was removed for flutter/flutter/175047, because - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label. |
Manual roll Flutter from e11e2c1 to 7cd821c (73 revisions) Manual roll requested by tarrinneal@google.com flutter/flutter@e11e2c1...7cd821c 2025-10-14 bruno.leroux@gmail.com Fix computeDistanceToActualBaseline throws when accessing child size (flutter/flutter#176906) 2025-10-14 47866232+chunhtai@users.noreply.github.com iOS can set application locale before view controller is set (flutter/flutter#176592) 2025-10-14 jason-simmons@users.noreply.github.com Roll ANGLE to a branch based on d9fa255a5c22 (flutter/flutter#176747) 2025-10-14 47866232+chunhtai@users.noreply.github.com Relands "Fixes keyboard selects disabled radio" (flutter/flutter#176977) 2025-10-14 huy@nevercode.io Fix expansion tile is missing state announcement on non-Apple platforms (flutter/flutter#175480) 2025-10-14 30870216+gaaclarke@users.noreply.github.com impeller: allows access of float uniforms by name (flutter/flutter#176728) 2025-10-14 aam@google.com Roll dart sdk to 3.11.0-17.0.dev (flutter/flutter#176947) 2025-10-13 okorohelijah@google.com Move iOS integration tests (flutter/flutter#176940) 2025-10-13 ahmedsameha1@gmail.com Make sure that an InputDatePickerFormField doesn't crash in 0x0 envir… (flutter/flutter#176047) 2025-10-13 jason-simmons@users.noreply.github.com [web] Match the behavior of other platforms in Web Locale.toString if the country code is an empty string (flutter/flutter#176862) 2025-10-13 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Fixes keyboard selects disabled radio (#176727)" (flutter/flutter#176958) 2025-10-13 47866232+chunhtai@users.noreply.github.com Fixes keyboard selects disabled radio (flutter/flutter#176727) 2025-10-13 engine-flutter-autoroll@skia.org Roll Packages from e319c40 to d062181 (2 revisions) (flutter/flutter#176916) 2025-10-13 jason-simmons@users.noreply.github.com Roll SwiftShader to 794b0cfce1d8 (flutter/flutter#176806) 2025-10-13 32538273+ValentinVignal@users.noreply.github.com Make DropdownMenu generic type non nullable (flutter/flutter#176711) 2025-10-12 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from BWGpRvpdQh-HJpq1c... to _dd0Jv50H0oUI2Ad8... (flutter/flutter#176895) 2025-10-11 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from JpiUsek1hU5r9QVKP... to BWGpRvpdQh-HJpq1c... (flutter/flutter#176880) 2025-10-11 codefu@google.com fix: content hash check for LUCI_CONTEXT (flutter/flutter#176867) 2025-10-11 34465683+rkishan516@users.noreply.github.com Feat: make tooltip position customizeable (flutter/flutter#175047) 2025-10-11 engine-flutter-autoroll@skia.org Roll Dart SDK from d88d8bf2b53c to 65b171958c93 (3 revisions) (flutter/flutter#176871) 2025-10-11 34465683+rkishan516@users.noreply.github.com feat: apply radioGroup role to segmented control widgets (flutter/flutter#176157) 2025-10-10 ahmedsameha1@gmail.com Make sure that a CheckboxMenuButton doesn't crash in 0x0 environment (flutter/flutter#176450) 2025-10-10 Rusino@users.noreply.github.com [WebParagraph] Support for more styles, placeholders, decorations, etc (flutter/flutter#172853) 2025-10-10 jason-simmons@users.noreply.github.com Set up a version of build_ios_framework_module_test that only runs on x64 machines and extend its timeout (flutter/flutter#176811) 2025-10-10 engine-flutter-autoroll@skia.org Roll Packages from 0b41de3 to e319c40 (1 revision) (flutter/flutter#176833) 2025-10-10 danny@tuppeny.com [tool/dap] Forward app.warning events from Flutter to DAP client (flutter/flutter#176827) 2025-10-10 engine-flutter-autoroll@skia.org Roll Dart SDK from 70c00d3ceb3a to d88d8bf2b53c (1 revision) (flutter/flutter#176830) 2025-10-10 sokolovskyi.konstantin@gmail.com Remove unnecessary nullable types in examples. (flutter/flutter#176713) 2025-10-10 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from xArtL4DH0FsdwSqG_... to JpiUsek1hU5r9QVKP... (flutter/flutter#176822) 2025-10-10 bruno.leroux@gmail.com Cleanup OutlinedButton.icon documentation and implementation (flutter/flutter#176630) 2025-10-10 34871572+gmackall@users.noreply.github.com [HCPP] Properly remove hcpp views that are no longer visible (flutter/flutter#176742) 2025-10-10 ahmedsameha1@gmail.com Make sure that an InputChip doesn't crash in 0x0 environment (flutter/flutter#175930) 2025-10-10 737941+loic-sharma@users.noreply.github.com Update Flutter templates' Dart style (flutter/flutter#175963) 2025-10-10 ahmedsameha1@gmail.com Make sure that a DropdownButtonFormField doesn't crash in 0x0 environ… (flutter/flutter#174958) 2025-10-10 ahmedsameha1@gmail.com Make sure that an InkWell doesn't crash in 0x0 environment (flutter/flutter#175871) 2025-10-10 ahmedsameha1@gmail.com Handle#6537 end drawer button (flutter/flutter#173026) 2025-10-10 engine-flutter-autoroll@skia.org Roll Dart SDK from a9b7bd4b0b32 to 70c00d3ceb3a (4 revisions) (flutter/flutter#176815) 2025-10-10 robert.ancell@canonical.com Change default Linux thread policy to merge platform and UI threads. (flutter/flutter#176759) 2025-10-09 bkonyi@google.com [ Tool ] Roll package:dwds to 26.0.0 (flutter/flutter#176808) 2025-10-09 43054281+camsim99@users.noreply.github.com Update `CHANGELOG` to include 3.35.6 notes (flutter/flutter#176803) 2025-10-09 36861262+QuncCccccc@users.noreply.github.com Announce text and button together when DropdownMenu is treated as a button (flutter/flutter#176428) 2025-10-09 gregorysconrad@gmail.com [native_assets] create macOS CCompilerConfig via xcrun --find (flutter/flutter#175717) 2025-10-09 chinmaygarde@google.com [Impeller] Fix broken links in README. (flutter/flutter#176770) 2025-10-09 chinmaygarde@google.com Fix links to Custom Flutter Engine Embedders in README. (flutter/flutter#175807) ...
This MR adds positionDelegate argument to tooltip which allows to change tooltip position. fixes: flutter#172758 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
This MR adds positionDelegate argument to tooltip which allows to change tooltip position.
fixes: #172758
Pre-launch Checklist
///).