palantir/blueprint

TagInput should have a string-only variant with simpler prop types

Open

#4,390 opened on Oct 27, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Package: coreType: enhancementhelp wanted

Description

Working with onRemove: (value: React.ReactNode, index: number) is inconvenient under TypeScript's strict compiler options. Even when the values prop is string[], you are either forced to type cast the removed value to string or use the index parameter to index into your values array. We should make the simple case easier to work with, either with a new component API or changing the existing component to be parameterized by its data type <T>.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React component developmentTypeScript genericsFamiliarity with TagInput API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Implement a generic version of TagInput where the value type can be specified. The existing component in packages/core/src/components/tag input/tagInput.tsx needs to be updated to accept a generic type parameter T. The onRemove callback should infer the type from the values array. Consult the repository's contribution guidelines and existing similar patterns in the codebase (e.g., other generic components). A pull request should be opened with changes to the component and its TypeScript definitions.