Semantic-Org/Semantic-UI-React

StrictTextAreaProps has a type that includes number and undefined for the "value" field

Open

#4,464 opened on Feb 20, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (4,065 forks)batch import
buggood first issue

Repository metrics

Stars
 (13,136 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Bug Report

Steps

<Form.TextArea onChange={(_: unknown, data: TextAreaProps) => {
  const s: string =  data.value;
}}/>

Expected Result

No TypeScript errors.

Actual Result

Type 'string | number | undefined' is not assignable to type 'string'.

Version

2.1.5

Testcase

https://codesandbox.io/p/sandbox/semantic-ui-react-forked-5tf5yh

Notes

It doesn't appear to be possible to actually set the value of the textarea to a number or undefined, so it's not clear why I'd have to cast, and it's very inconvenient to cast undefined to a String since String(undefined) is "undefined" instead of "".

Contributor guide

Research direction
Look at the type definition for StrictTextAreaProps in the Form.TextArea component source. The issue is that 'value' is typed as string | number | undefined, but it should only be string. Find the type file (likely in src/components/Form/FormTextArea.d.ts) and update the type to be string. Ensure that changing this does not break other uses of the same prop in other components.
Tech stack
reacttypescript
Domain
frontend
Issue type
Bug
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
TypeScript basicsReact components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80