palantir/blueprint

[select] On rerender / item list change, Suggest does not set active item to selected item

Open

#4,562 opened on Mar 4, 2021

View on GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P3Package: selectType: bughelp wanted

Description

Environment

  • Package version(s):
    • @blueprintjs/core: 3.39.0
    • @blueprintjs/select: 3.15.5
  • Operating System: all
  • Browser name and version: all

Code Sandbox

Link to a minimal repro: https://codesandbox.io/s/blueprint-sandbox-forked-rf75x?file=/src/index.tsx

Steps to reproduce

  1. Click Suggest input, note that 3 is active.
  2. Click "Reload item list," which simulates reloading list from network, etc.
  3. Click Suggest input, note that 1 is active instead 3, which is selected
  4. Blur focus on Suggest
  5. Click Suggest input again, note that active item finally resets to 3

Actual behavior

In step 3 above, the selected item is not active.

Expected behavior

In step 3, the selected item is active (assuming it's in the new list).

Possible solution

Might be that than maybeResetActiveItemToSelectedItem should be called in wider conditions than https://github.com/palantir/blueprint/blob/develop/packages/select/src/components/select/suggest.tsx#L157? But not too familiar with the implementation of Suggest.

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptBlueprint Suggest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue describes that the Suggest component's active item does not reset to the selected item when the item list changes. The report includes a CodeSandbox reproduction and points to suggest.tsx line 157 where maybeResetActiveItemToSelectedItem is called. A potential fix is to call that function in broader conditions, such as when the items prop changes. The maintainer should review the component's lifecycle and ensure the active item is updated when the list updates.