angular/components

bug(material/tooltip): tooltip inside sidenav hides after text update

Open

#27,782 建立於 2023年9月12日

在 GitHub 查看
 (6 留言) (3 反應) (0 負責人)TypeScript (24,044 star) (6,650 fork)batch import
P4area: material/tooltiphelp wanted

描述

Is this a regression?

  • Yes, this behavior used to work in the previous version

The previous version in which this bug was not present was

No response

Description

When the tooltip component overflows a parent sidenav and its text content is updated dynamically, it hides.

We have debugged the code, and this happens because the sidenav component extends the cdk-scrollable.

The piece of code that calls the tooltip hide function is the following: https://github.com/angular/components/blob/bae953999407fd385b1d571e04350bf0f28abf05/src/material/tooltip/tooltip.ts#L510-L520

Reproduction

Stackblitz url: https://stackblitz.com/edit/stackblitz-starters-wbd1hh?file=src%2Ftooltip-sidenav%2Ftooltip-sidenav.component.html

As you can see on the stackBlitz example, we have two tooltips:

  • The tooltip inside the sidenav, which overflows the sidenav component. That if we update the tooltip text, the tooltip disappears. (BUG)
  • On the other hand, we have the tooltip inside the mat-sidenav-content which works properly, and it doesn't hide after updating it. (WORKS WELL because doesn't overflow the parent)

Expected Behavior

The tooltip inside the sidenav should not hide when the text is updated.

Actual Behavior

The tooltip placed inside the sidnav that overflows is hidden suddenly when the text is updated.

Environment

  • Angular: v16.2.4
  • CDK/Material: v16.2.3
  • Browser(s): Google chrome Versión 116.0.5845.187, Firefox 117.0
  • Operating System (e.g. Windows, macOS, Ubuntu): Windows

貢獻者指南

技術棧
typescript
領域
frontend
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Angular MaterialCDK ScrollingTypeScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Investigate the tooltip hide logic in src/material/tooltip/tooltip.ts around line 510-520, where a scroll event listener on the parent scrollable triggers tooltip hiding. The bug occurs when tooltip text is updated while inside a sidenav (which extends cdk scrollable), causing the tooltip to disappear. Check if the scroll event is fired erroneously on text update; consider adding a check to verify the scroll position actually changed before hiding. Review the CDK scrollable directive behavior and the StackBlitz reproduction to confirm the root cause.