downshift-js/downshift

TypeScript: have items and selectedItems as Readonly

Open

#1030 opened on Apr 30, 2020

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (11,761 stars) (980 forks)batch import
TypeScripthelp wanted

Description

  • downshift version:
  • node version:
  • npm (or yarn) version:

Relevant code or config

What you did:

What happened:

Reproduction repository:

Problem description: Since we use items/selectedItems just for some logic and we do not tamper with them, we can mark them as read only in the TS interface.

Suggested solution: In typings.ts for useSelect, useCombobox and useMultipleSelection, use Readonly to wrap the items type.

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic TypeScript knowledgeFamiliarity with downshift typings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate typings.ts file in the downshift source code. For hooks useSelect, useCombobox, and useMultipleSelection, modify the type definitions to wrap the items and selectedItems properties with Readonly<T> to indicate they are not mutated. Ensure consistency across all three hooks. No logic changes required.