palantir/blueprint

Add shouldReturnFocusOnClose property to Toaster

Open

#6018 opened on Mar 14, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P3Package: coreType: feature requesthelp wanted

Description

I see that in this ticket #5032 there was removed a feature of returning focus to previously focused element when toaster is closed. But actually I need this for my case. Could the property "shouldReturnFocusOnClose " be added to Toaster, so I developer could deside wether they want or not focus to be returned to previous active element? So it would be like that toaster.show({ message: message, shouldReturnFocusOnClose: true })

To do this, just a simple change need to be done. "render" function in "toaster.tsx" should pass this property to Overlay's shouldReturnFocusOnClose; instead of setting it to "false".

Contributor guide

Tech stack
reacttypescript
Domain
frontend
Issue type
feature
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React knowledgeTypeScript knowledgeBlueprint Toaster API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding a shouldReturnFocusOnClose prop to the Toaster component. The implementation involves modifying the render function in toaster.tsx to pass this prop to the Overlay component instead of hardcoding false. Reference the previous ticket #5032 for context on why the focus return was removed. Check the Overlay component's shouldReturnFocusOnClose prop and ensure backward compatibility (default false). Also consider updating documentation and tests.