refactor: MailtoLink component migrated to TS#4140
Conversation
|
Thanks for the pull request, @jesusbalderramawgu! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
✅ Deploy Preview for paragon-openedx-v23 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## release-23.x #4140 +/- ##
================================================
- Coverage 94.39% 94.31% -0.08%
================================================
Files 242 242
Lines 4296 4307 +11
Branches 1020 988 -32
================================================
+ Hits 4055 4062 +7
- Misses 237 241 +4
Partials 4 4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Hi @openedx/committers-paragon would someone be able to take a look at this for us? Thanks! |
|
|
||
| it('renders empty mailtoLink', () => { | ||
| const { getByText } = render(<MailtoLinkWrapper content={content} />); | ||
| const { getByText } = render(<MailtoLinkWrapper>{children}</MailtoLinkWrapper>); |
There was a problem hiding this comment.
@jesusbalderramawgu This looks like a change to the API of the component. We can expect this to break downstream uses of it. Is there a particular reason we need to make this change as part of the TypeScript conversion?
There was a problem hiding this comment.
@Kelketek This change is only in the test code, and in the actual code, content was deprecated in favor of children 7 years ago (!), so I think this is fine :)
paragon/src/MailtoLink/index.tsx
Lines 81 to 86 in 2311575
bradenmacdonald
left a comment
There was a problem hiding this comment.
The prop types are not showing up properly on the docs site: https://deploy-preview-4140--paragon-openedx-v23.netlify.app/components/mailtolink/#props-api
The reason is what's mentioned on #3739:
🤔 Note that components using
forwardRefrequire a very specific syntax in order for the props documentation to be detected correctly:
❌ Won't work (props documentation will be missing) ✅ Works (props will be documented)
Please fix that and then I think this should be good to go.


Description
Migration of MailToLink component to TypeScript following this issue
Merge Checklist
Post-merge Checklist