Repository navigation
Conversation
Partial<ClassNames> rejected string | undefined under exactOptionalPropertyTypes. Align ClassNames with Styles so classNames accepts clsx/cva results without making keys optional.
🦋 Changeset detectedLatest commit: f157090 The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ClassNamesvalues arestring | undefined, soPartial<ClassNames>acceptsstring | undefinedfromclsx/cva/ similar helpers under TypeScriptexactOptionalPropertyTypes(TS2375). Keys stay required; they are not made optional.The public API change is types-only. Internally, values are narrowed before
classList/string[], which is whattscrequires after that change.Fixes #3015.
Decision
Chose
ClassNamesvaluesstring | undefined, matchingStylesand the change proposed in the issue.The alternative is to keep
ClassNamesasstringand only widen theclassNamesprop to{ [K in keyof ClassNames]?: string | undefined }, sogetDefaultClassNames()/useDayPicker().classNamesstay definitelystringand the animation / modifier helpers need no edits.Happy to switch to the prop-only widen.
Test plan
pnpm --filter react-day-picker typecheck(fails without theClassNamesvalue change; passes with it)tscwithexactOptionalPropertyTypes: trueassigning{ root: string | undefined }toPartial<ClassNames>jest --selectProjects src --testPathPatterns='types/props.test|useAnimation.test|getDefaultClassNames.test'pnpm testandpnpm typecheckas in CONTRIBUTING.md