just_tooltip 0.4.4
just_tooltip: ^0.4.4 copied to clipboard
A lightweight, customizable Flutter tooltip with flexible placement, hover & tap triggers, programmatic control, and RTL support.
0.4.4 #
Fixed #
- A tooltip that can never show no longer suppresses the tooltips around it (#46). With
hideOnEmptyMessage(the default) an emptymessagemeans "draw nothing" — but the suppression was claimed fromMouseRegion.onEnter, before that was known, so hovering such a tooltip nested inside another showed nothing at all: not the inner one, not the outer one.- Reachable from ordinary data. A cell tooltip whose text is
''for "no description", inside a row-level tooltip, silently kills the row's. - Two packages had independently grown the same local guard rather than report it, which is what a trap in the upstream default looks like.
- Reachable from ordinary data. A cell tooltip whose text is
- A tooltip now follows its
messagewhile it is already on screen or under a resting pointer. Content that arrives makes it appear; content that leaves makes it disappear at once, bypassingshowDurationas suppression already did. Previously neither was noticed until the pointer left and returned.- This holds however the tooltip was opened. A tooltip shown by
controller.show()has no hover intent to lose, so an emptiedmessageused to leave it standing — with the overlay now following the widget, that would have drawn an empty bubble in defiance ofhideOnEmptyMessage. Showing is gated on content; hiding now is too.
- This holds however the tooltip was opened. A tooltip shown by
- A shown tooltip now follows its own configuration (#47). Changing
message,tooltipBuilder,theme,directionoralignmentwhile the tooltip is on screen had no effect: the overlay entry renders all of them live, but nothing ever asked it to rebuild. It now rebuilds on the next frame after any widget update.- A
tooltipBuilderthat reads mutable state at call time —(_) => Text(_message)— appeared to work, because the stale closure returned the new value. Capture the value instead and both paths were equally stale. Anyone verifying this should use the capturing form.
- A
Changed #
- Nesting Suppression now reads "the innermost tooltip under the pointer that has something to draw wins". Having nothing to draw is no longer enough to take an ancestor's place.
hideOnEmptyMessage: falseasks for the empty bubble, so such a tooltip draws, and suppresses exactly as before.
0.4.3 #
Fixed #
- An
interactivetooltip no longer dies for good when the cursor returns from the tooltip body to its child (#43). Leaving the tooltip arms the 100 ms Hover Bridge; re-entering the child did not cancel it, so it fired unseen, started a fade-out, and nothing revived it — a pointer that never left the child sends no furtheronEnter. The tooltip vanished about 250 ms after the cursor came home and stayed gone.- The reverse-catch could not help: the show request arrives while the animation is still running forward, and the reverse only begins 100 ms later, when nobody is asking to show.
- Invisible at the moment it happens. The bridge fires while the tooltip is still on screen; it disappears 150 ms afterwards, a quarter second removed from its cause.
TooltipAnchor.pointermakes it easy to hit, since the tooltip is drawn beside the cursor.
0.4.2 #
Changed #
- Minimum Flutter is now
3.13.0(Dart3.1.0), up from3.10.0(#38). The ancestor clip walk below readsRenderObject.parent, which wasAbstractNode?— a type with nodescribeApproximatePaintClip— until Flutter 3.13.
Fixed #
- Behaviour change.
TooltipAnchor.childnow targets the visible part of the child rather than its whole rect (#33). A child wider than the ancestor clipping it — a row inside a horizontal scroll viewport, say — had its tooltip aimed at a centre nobody could see. Measured: a 900px child in a 400px viewport placed its tooltip atx = 450, entirely outside the scroll view, with the cursor atx = 200.screenMarginnever helped: it confines the tooltip to theOverlay, usually the whole app, which an off-screen anchor satisfies.- A viewport reports a clip whenever
clipBehavioris notClip.none, so anyJustTooltipinside aListVieworSingleChildScrollViewmay shift — always toward the visible part. An unclipped child is unaffected. TooltipAnchor.pointerwas never affected, which is why both known downstreams had independently adopted it as a workaround.- A child clipped away entirely — reachable only via
controller.show(), since a hovering pointer proves a visible part exists — anchors at the clip edge the child lies beyond rather than refusing to show. Hiding is reserved for losing a target you had: see the tracking entry below.
- A visible tooltip now tracks its child (#35). The target was resolved once, when the tooltip appeared, so a scroll, a resize, a layout animation, or an insertion above the child left the tooltip pointing where the child used to be. It now re-aims after any frame that moves the child, and hides once a child it was pointing at is clipped away entirely — nothing to point at, no tooltip. Hiding is a transition, not a state:
controller.show()against a child that was already out of sight anchors at the clip edge rather than refusing, keeps tracking, and re-aims onto the child as soon as it scrolls into view. - The target rect now follows the child's paint transform.
Transform.scalebetween the child and theOverlaypreviously produced a target whose origin was transformed but whose size was not, so a2.0-scaled 100×50 child yielded a 100×50 target at the origin and aTooltipDirection.bottomtooltip drawn on top of the child instead of below it.
0.4.1 #
Added #
JustTooltipTheme.bare()(#30). A theme that draws no background, padding, shadow, border, or arrow — for atooltipBuilderwhose widget already draws its own surface, leaving the tooltip to contribute positioning and nothing else. Previously this meant zeroingbackgroundColor,padding, andelevationby hand at every call site, where omitting any one of them silently reintroduced chrome.
0.4.0 #
Added #
JustTooltip.anchorandTooltipAnchor(#21).TooltipAnchor.pointerkeeps the child as the hover region but anchors the tooltip at the cursor — for a child much wider than the pointer's neighbourhood (a table row, a wide card), whose centre is nowhere near where the user is looking. Defaults toTooltipAnchor.child, the existing behaviour.- The anchor is captured when the tooltip is shown and does not follow the pointer, so
interactivetooltips stay reachable. - Tap-triggered tooltips anchor at the tap; a touch fires no hover events, so the tap-down supplies the position.
- A programmatic
controller.show()with no pointer present falls back to the child's rect. - Against a point there are no target edges to align to, so
alignmentsays which of the tooltip's own edges lands on the pointer.
- The anchor is captured when the tooltip is shown and does not follow the pointer, so
Changed #
- Behaviour change for nested tooltips. A
JustTooltipcontaining the pointer now suppresses every enclosingJustTooltip, regardless of registry. If you relied on a nested tooltip and its ancestor being visible together (only reachable by giving them separateTooltipRegistryinstances), that no longer happens. Suppression gates hover only — a programmaticcontroller.show()is unaffected.
Fixed #
-
Nested
JustTooltips now reliably show only the innermost tooltip under the pointer (#22). Previously this held only by coincidence — the "one tooltip at a time" registry dismissed the ancestor after it had shown — and broke in three ways:- an ancestor's
waitDurationtimer would fire while the pointer rested on a nested child, replacing the inner tooltip with the outer one; - moving from a nested child back onto its ancestor showed nothing at all, because the ancestor's hover region was never exited and so never re-entered;
- tooltips scoped to separate
TooltipRegistryinstances showed both at once.
- an ancestor's
-
The tooltip is now positioned against its target in the coordinate space of the
Overlayit is laid out in, rather than the window's (#24). The two coincide for a full-windowMaterialApp, so nothing changes there — but a tooltip under a nestedNavigator, an insetOverlay, or an embedded Flutter view was displaced by the Overlay's offset, and its direction flipping andscreenMarginclamping were measured against the wrong bounds.
Internal #
- Pointer facts (
_pointerInside, and the pointer's last position) are now retained and a hover intent boolean derived from them, coalesced into a microtask and handed toTooltipVisibilityScheduleron transition only. This makes hover behaviour independent of Flutter'sMouseTrackerdispatch order. See ADR-0003. The one collaborator that must observe a hover transition synchronously — the tooltip body'sonEnter, which cancels the hover bridge — flushes the pending recomputation first. TooltipVisibilitySchedulerandTooltipRegistryare unchanged.JustTooltipPositionDelegate.targetRectis documented as being in theOverlay's coordinate space; the child rect and the pointer anchor both arrive in it.- A second example entry point (
example/lib/spike_wide_row.dart) exercises pointer anchoring, nested suppression, an insetOverlayand an interactive tooltip together. - Test coverage: 125 tests. Every test added this release was mutation-checked — reverting the code it covers must make it fail.
0.3.0 #
Breaking #
JustTooltipControlleris no longer aChangeNotifier. It is now an attach-based command source (modeled on Flutter'sOverlayPortalController):show()/hide()/toggle()drive the attached tooltip, which is the single source of truth for visibility.- removed the
shouldShowgetter — useisShowing(reflects the tooltip's live state) instead - removed
addListener/removeListener/dispose(ChangeNotifierAPI) — observe visibility via the widget'sonShow/onHidecallbacks - removed the internal
resetShouldShow()
- removed the
- Narrowed the public API —
JustTooltipPositionDelegate,TooltipShapePainter, andJustTooltipOverlayare no longer exported (they are internal implementation details). The public surface is nowJustTooltip,JustTooltipController,JustTooltipTheme,TooltipRegistry, and the enums.
Added #
- An optional
registryparameter andTooltipRegistryclass to scope the "one tooltip visible at a time" policy — pass a sharedTooltipRegistry()to a group of tooltips to isolate them (or a test); omitting it keeps the app-global default.
Fixed #
controller.show()called before theJustTooltipmounts is now honoured (the queued show is applied once mounted); previously it was ignored.slideandfadeSlideanimations now enter from the auto-flipped (resolved) direction — a tooltip that flips (e.g.top→bottomnear a screen edge) slides in from the side it actually appears on, not the originally-requested one.
Internal #
- Extracted the hover/auto-hide timing into a dedicated
TooltipVisibilityScheduler(timer cancellation collapsed into one place). - Extracted the 7 show/hide animations into a dedicated
TooltipTransitionsmodule. - Moved the single-visible-tooltip policy out of a static
Setinto the injectableTooltipRegistry. - Test coverage raised to ~97% (scheduler, transitions, registry, controller, painter, and hover integration).
0.2.5 #
- feat add
TooltipAlignment.startTargetCenterandendTargetCenteralignments where the arrow dynamically points to the center of the target widget - example add
Top-StartTargetandTop-EndTargetquick presets to playground
0.2.4 #
- feat add
hideOnEmptyMessageparameter to suppress tooltip whenmessageis empty (default:true) - example add
hideOnEmptyMessagetoggle to Content section in playground
0.2.3 #
- fix
borderColornot visible on non-arrow tooltips (showArrow: false) due toMaterialbackground coveringDecoratedBoxborder
0.2.2 #
- fix rename
TooltipPositionDelegate→JustTooltipPositionDelegateto resolve name conflict with Flutter SDK'sTooltipPositionDelegate(introduced in Flutter 3.32)
0.2.1 #
- feat add
TooltipAnimationenum with 7 animation types:none,fade,scale,slide,fadeScale,fadeSlide,rotation - feat add
animationandanimationCurveparameters for animation type and curve selection - feat add
fadeBegin,scaleBegin,slideOffset,rotationBeginparameters for fine-tuning animations - docs add Animation section to README with usage examples and API reference
- example add Animation section with type/curve dropdowns and parameter sliders
0.2.0 #
- BREAKING extract 12 visual styling parameters into
JustTooltipThemeclassbackgroundColor,borderRadius,padding,elevation,boxShadow,borderColor,borderWidth,textStyle,showArrow,arrowBaseWidth,arrowLength,arrowPositionRatioare now accessed viathemeparameter- Migration: wrap style params in
theme: JustTooltipTheme(...)
- feat add
JustTooltipTheme.copyWith()for easy theme derivation - feat
JustTooltipThemeis a reusable data class with==/hashCodesupport
0.1.7 #
- fix controller
show()not working after tooltip was dismissed by hover-out or auto-hide
0.1.6 #
- feat add
showArrowparameter with unified path rendering (arrow integrated into tooltip shape) - feat add
arrowBaseWidthandarrowLengthparameters for arrow size customization - feat add
arrowPositionRatioparameter to control arrow placement along the tooltip edge - feat add
borderColorandborderWidthparameters for tooltip outline (follows arrow shape) - feat arrow auto-flips with tooltip direction when viewport space is insufficient
- fix tooltip not reappearing when re-hovering during fade-out animation
0.1.5 #
- feat add viewport overflow protection with auto direction flip and position clamping
- feat add
screenMarginparameter to control minimum distance from screen edges - docs
tooltipBuildernow documents that content sizing is the caller's responsibility
0.1.4 #
- fix
interactivemode now properly pauses auto-hide timer while cursor is on tooltip
0.1.3 #
- feat add
boxShadowparameter for custom shadow control (color, blur, spread, offset)
0.1.2 #
- feat add
interactiveoption to control whether tooltip stays visible on hover - feat add
waitDurationfor delayed tooltip appearance on hover - feat add
showDurationfor auto-hiding tooltip after a set time with timer reset on re-enter
0.1.1 #
- feat add
crossAxisOffsetparameter for shifting tooltip along the cross-axis
0.1.0 #
- implement JustTooltip core widget with direction (top/bottom/left/right) + alignment (start/center/end)
- implement JustTooltipController for programmatic show/hide/toggle
- implement tooltip position utils with 12-combination anchor mapping and RTL support
- feat hover and tap trigger modes
- feat fade animation with configurable duration
- feat custom tooltip content via
tooltipBuilder - feat single-instance enforcement (only one tooltip visible at a time)
- feat interactive playground example app with theme switching