fix: Export missing type AnimationConfig
#2128
Merged
Conversation
This file contains 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
Some open-source and largely used libraries such as nivo directly bind to the types being declared by `@react-pring/core` in some of their code.
For instance in nivo, the following code:
```ts
import { SpringValues } from '@react-spring/web'
//...
export interface NodeProps<Datum extends object> {
//...
animatedProps: SpringValues<NodeAnimatedProps>
//...
}
```
Implicitely force nivo to be able to reference parts of the typings of `@react-spring/core` into their d.ts files if they want to be able to publish their package. It basiaclly results into `Partial<import("@react-spring/core").AnimationConfig>` in the produced d.ts at some point. And as a consequence TypeScript complains with the error `error TS4023: Exported variable 'htmlDefaultProps' has or is using name 'AnimationConfig' from external module "/tmp/9a4cf066/node_modules/@react-spring/core/dist/index" but cannot be named.`.
The proposed change exposes `AnimationConfig` as a type, meaning we still don't expose the class, just its type. It would help into making nivo able to support recent version of `@react-spring/*`. See related issue on nivo's side: plouc/nivo#2280
🦋 Changeset detectedLatest commit: e578cbe The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
joshuaellis
previously approved these changes
Mar 29, 2023
|
Not sure the codesandbox issue is related to my change 🤔
|
|
No it's not you, i need to remove the sandbox CI. |
joshuaellis
approved these changes
Mar 29, 2023
|
Thank you so much for the quick approval and merge. And of course for this awesome library 👍 |
|
Hey @joshuaellis, Just wondering, any plan to do a release with this patch? |
|
Sorry i've been away, this has now been released! :) |
|
Thank you so much |
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.
Some open-source and largely used libraries such as nivo directly bind to the types being declared by
@react-pring/corein some of their code.For instance in nivo, the following code:
Implicitely force nivo to be able to reference parts of the typings of
@react-spring/coreinto their d.ts files if they want to be able to publish their package. It basiaclly results intoPartial<import("@react-spring/core").AnimationConfig>in the produced d.ts at some point. And as a consequence TypeScript complains with the errorerror TS4023: Exported variable 'htmlDefaultProps' has or is using name 'AnimationConfig' from external module "/tmp/9a4cf066/node_modules/@react-spring/core/dist/index" but cannot be named..The proposed change exposes
AnimationConfigas a type, meaning we still don't expose the class, just its type. It would help into making nivo able to support recent version of@react-spring/*. See related issue on nivo's side: plouc/nivo#2280Why
What
Checklist