downshift-js/downshift

TypeScript: have items and selectedItems as Readonly

Open

#1,030 opened on Apr 30, 2020

View on GitHubContributor guide
 (4 comments) (1 reaction) (0 assignees)JavaScript (980 forks)batch import
TypeScripthelp wanted

Repository metrics

Stars
 (11,761 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Open the typings.ts file for useSelect, useCombobox, and useMultipleSelection, then wrap the items and selectedItems types with Readonly.
Tech stack
typescriptreactjavascript
Domain
frontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85