palantir/blueprint

Toaster with timeout zero is dismissed early

Open

#6742 opened on Mar 14, 2024

View on GitHub
 (6 comments) (1 reaction) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Package: coreType: bughelp wanted

Description

Environment

  • Package version(s): "@blueprintjs/core": "^5.10.0",
  • Operating System: Mac OS 14
  • Browser name and version: Chrome 122

Code Sandbox

Code sandbox

Steps to reproduce

See the linked code sandbox

  1. Open a Toast with timeout of 0. Note that focusing the toast will dismiss it (without clicking the 'x')
  2. Note that with an explicit timeout (e.g. 100_000) this is not the case; Toast remains open after focusing.
  3. timeout: Infinity is poorly behaved; Toast immediately closes

Actual behavior

See above and also screen recording from sandbox:

https://github.com/palantir/blueprint/assets/20345725/40bc7800-1b37-4cf9-bd1a-405425e835df

Expected behavior

Toast with timeout: 0 should not dismiss early. timeout: Infinity should also behave the same as timeout: 0

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptBlueprint toast component
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The bug is in the Toast component's timeout handling. Investigate the toast.tsx file to see how the dismiss timer is set up and how the `onFocus` handler triggers early dismissal. The issue is that when timeout is 0 or Infinity, the component incorrectly dismisses on focus. The fix likely involves treating 0 as infinite timeout (like `Infinity`) and ensuring the focus dismissal logic checks for these values. Look at the conditional in the timer setup and the `handleFocus` function.