palantir/blueprint

`createNewItemFromQuery` fired on every key press

Open

#4,510 opened on Jan 28, 2021

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

Description

Environment

  • Package version(s): @blueprintjs/core3.38.1 @blueprintjs/icons3.24.0 @blueprintjs/select3.15.3
  • Operating System: Mac OS 11.1
  • Browser name and version: Safari 14.0.2; Chrome 88.0.4324.96

Sandbox

https://stackblitz.com/edit/blueprint-select-create-new-item-bug?file=src/App.js

Steps to reproduce

  1. Open the stackblitz dev console or your web browser's console.
  2. Type anything into the suggest box.
  3. Observe that "create new tag" is called every time you type a new character.

Actual behavior

createNewItemFromQuery is being fired on every key press, and not just by (from the docs) "pressing the Enter key or by clicking on the "Create Item" option".

Expected behavior

createNewItemFromQuery should only fire when pressing the Enter key or when clicking on the "Create Item" option.

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.
1-3 hours
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
ReactTypeScriptBlueprint select
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the `Suggest` component in `@blueprintjs/select` to locate where `createNewItemFromQuery` is called. The bug indicates it fires on every key press rather than only on Enter or click. Examine the key press event handlers and the logic that triggers the creation. The expected behavior is that it should only be invoked when the Enter key is pressed or when the user clicks the 'Create Item' option. Check the component's state management and look for any recent changes that might have introduced this regression. The sandbox provided should help reproduce the issue.