Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: Typescript types incomplete for DatePicker component #16084

Closed
2 tasks done
ychavoya opened this issue Mar 27, 2024 · 0 comments · Fixed by #16334
Closed
2 tasks done

[Bug]: Typescript types incomplete for DatePicker component #16084

ychavoya opened this issue Mar 27, 2024 · 0 comments · Fixed by #16334
Assignees
Labels

Comments

@ychavoya
Copy link
Contributor

Package

@carbon/react

Browser

No response

Package version

v1.53.1

React version

v18.2.0

Description

Some of the typings for the DatePicker component that are passed directly to flatpickr are incomplete (missing some of the possible types), meaning that Typescript can add a warning/error to a provided prop even though the value is valid to flatpickr.

enable, disable

I found this with the enable and disable props. In @carbon/react they are of type string[]:

While in flatpickr they are of type DateLimit<DateOption>[], which is equivalent to (Date | string | number | { from: Date | string | number, to: Date | string | number } | ((date: Date) => boolean))[]:

https://github.com/flatpickr/flatpickr/blob/548330e6e18871d6ca1ca78746c0e89cb12a0303/src/types/options.ts#L124

minDate, maxDate

Also minDate and maxDate are missing the Date type since they are of type DateOption (Date | string | number) in flatpickr

https://github.com/flatpickr/flatpickr/blob/548330e6e18871d6ca1ca78746c0e89cb12a0303/src/types/options.ts#L156

And just string | number in @carbon/react

Reproduction/example

https://stackblitz.com/edit/vitejs-vite-81ltbd?file=src%2Fmain.tsx

Steps to reproduce

  1. Run a React Typescript project with @carbon/react
  2. Add a DatePicker with DatePickerInput
  3. Add one of the specified props to DatePicker with a Date value or one of the other unsupported value types ( eg: enable={[(date) => ![0, 6].includes(date.getDay())]} or minDate={new Date()})
  4. Run tsc --noemit
  5. You should receive an error/warning (depends on configuration) from Typescript
src/main.tsx:11:18 - error TS2322: Type '(date: any) => boolean' is not assignable to type 'string'.

11         enable={[(date) => ![0, 6].includes(date.getDay())]}
                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/main.tsx:12:9 - error TS2322: Type 'Date' is not assignable to type 'string | number | undefined'.

12         minDate={new Date()}
           ~~~~~~~

Suggested Severity

Severity 4 = Unrelated to a user task, has a workaround or does not need a workaround.

Application/PAL

No response

Code of Conduct

@sstrubberg sstrubberg moved this to 🕵️‍♀️ Triage in Design System Mar 28, 2024
@alisonjoseph alisonjoseph added severity: 4 https://ibm.biz/carbon-severity area: typescript labels Mar 29, 2024
@alisonjoseph alisonjoseph moved this from 🕵️‍♀️ Triage to ⏱ Backlog in Design System Mar 29, 2024
@riddhybansal riddhybansal self-assigned this Apr 24, 2024
@riddhybansal riddhybansal moved this from ⏱ Backlog to 🏗 In Progress in Design System May 6, 2024
@riddhybansal riddhybansal moved this from 🏗 In Progress to 🚦 In Review in Design System May 6, 2024
@github-project-automation github-project-automation bot moved this from 🚦 In Review to ✅ Done in Design System May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants