feat: add types for <ModalDialog> and some related components #3242
Conversation
|
Thanks for the pull request, @bradenmacdonald! What's next?Please work through the following steps to get your changes 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. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where 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. |
openedx-webhooks
added
the
open-source-contribution
✅ Deploy Preview for paragon-openedx ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3242 +/- ##
==========================================
+ Coverage 93.27% 93.31% +0.03%
==========================================
Files 249 249
Lines 4401 4441 +40
Branches 1038 1049 +11
==========================================
+ Hits 4105 4144 +39
- Misses 290 291 +1
Partials 6 6 ☔ View full report in Codecov by Sentry. |
bradenmacdonald
force-pushed
the
braden/modal-types
branch
from
ebf041c
to
620153b
Compare
| @@ -63,7 +68,7 @@ function ModalLayer({ | |||
| return null; | |||
| } | |||
|
|
|||
| const handleClose = isBlocking ? null : onClose; | |||
| const handleClose = isBlocking ? undefined : onClose; | |||
There was a problem hiding this comment.
This is fixing a minor type error - handleClose was getting passed to <FocusOn> via onEscapeKey but was sometimes null, whereas onEscapeKey expects either a function or undefined, not null.
Type 'null' is not assignable to type '((event: Event) => void) | undefined'.ts(2322)
types.d.ts(15, 5): The expected type comes from property 'onEscapeKey'
|
Thanks @PKulkoRaccoonGang ! |
|
🎉 This PR is included in version 22.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
This adds TypeScript types for:
ModalContextModalDialogModalDialog.HeaderModalLayerPortalBefore this change - no type checking in IDE, no inline docs:
After this change - type checking in IDE:
After this change - inline documentation of props in the IDE:
Deploy Preview
TBD
How to test
package.jsonby setting it to the latest published version (22.8.2, not 20.x!)ModalDialogusingnpm install --save ../paragon<ModalDialog>in.tsxfiles or in.jsxfiles that have// @ts-checkat the beginning. You can add// @ts-checkto the .jsx files if it's not there already.Merge Checklist
If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.Does your change adhere to the documented style conventions?Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?exampleapp?Is there adequate test coverage for your changes?Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.Post-merge Checklist