TypeScript types #490
Merged
TypeScript types #490
Conversation
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
|
That's a cool thing! I'll subscribe to updates, will be waiting :) P.S. Thanks for your work |
Contributor
|
Really excited about this! |
Contributor
Author
|
Done, I have now typed all components! 🎉 This is ready for a review 👍 |
mxstbr
commented
Jul 3, 2019
|
|
||
| export const UnderlineNav: React.FunctionComponent<UnderlineNavProps> | ||
|
|
||
| export const theme: Object |
Contributor
Author
There was a problem hiding this comment.
Note that the theme should be properly typed, but that would be a lot of effort 😅 I think this is good enough ™️ for a TypeScript MVP, and we can always improve this later.
mxstbr
commented
Jul 3, 2019
|
|
||
| #### Merge checklist | ||
| - [ ] Changed base branch to release branch | ||
| - [ ] Add or update TypeScript definitions (`index.d.ts`) if necessary |
Contributor
Author
There was a problem hiding this comment.
I added this little reminder to ensure the TypeScript definitions stay up to date, even when new components are added or old ones changed—happy to remove that again if you think it's unnecessary
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Adds TypeScript types to the components, so that any consumer only has to install the package and will automatically get the types. These were extracted from our internal project where I typed all the components we are currently using.
TODO
import Flex from '@primer/components/src/Flex'), we will need to update the types to also type the exportsCloses #389
I think it might be worth having a discussion on whether the package itself should be written in TypeScript, but that would be a much bigger change and this gets us 100% of the way there for all consumers.
Merge checklist