fix(core / swarmplot): Improve core and swarmplot typedefs #1151
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
areese159
changed the title
wyze
suggested changes
Oct 10, 2020
packages/swarmplot/index.d.ts
Outdated
| @@ -40,6 +56,8 @@ declare module '@nivo/swarmplot' { | |||
| event: React.MouseEvent<any> | |||
| ) => void | |||
|
|
|||
| export type Layers<Datum> = ((props: LayerProps<Datum>) => JSX.Element) | string | |||
There was a problem hiding this comment.
Can we make this consistent with other packages like bar or line. Change from string to a union of possible layers.
There was a problem hiding this comment.
Of course, ill get those changes pushed up tomorrow.
|
I think I have addressed your feedback, let me know if you want anything else changed. |
areese159
force-pushed
the
improve-core-swarmplot-typedefs
branch
from
32bf729
to
d698a83
Compare
|
Sorry, I made a typo, I've amended the commit and pushed the change. This should be good for rereview. |
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.
When implementing custom layers I noticed that the Pattern helpers were not being exported in the type def which caused us to have to use
@ts-ignorein our code base. I also noticed when working with swarmplots the type def also appeared to be slightly off. I propose two changes in this PR, the first being to export the pattern helpers in the type definition of @nivo/core and the second to give layers a real definition instead ofany[]in@nivo/swarmplot. If anything is not correct please let me know and I will be more than happy to fix it.