feat: added types for <Alert> component #3524

PKulkoRaccoonGang · 2025-04-08T07:41:52Z

Description

Added Typescript typing for Avatar component.

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?
Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
Were your changes tested in the example app?
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

Verify your changes were released to NPM at the expected version.
If you'd like, share your contribution in #show-and-tell.
🎉 🙌 Celebrate! Thanks for your contribution.

openedx-webhooks · 2025-04-08T07:41:55Z

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/paragon-working-group.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

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:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

netlify · 2025-04-08T07:42:12Z

✅ Deploy Preview for paragon-openedx-v22 ready!

Name	Link
🔨 Latest commit	`5e13302`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx-v22/deploys/67f7ee06d595420008c5e24c
😎 Deploy Preview	https://deploy-preview-3524--paragon-openedx-v22.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2025-04-08T07:51:16Z

Codecov Report

Attention: Patch coverage is 81.81818% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.50%. Comparing base (84350aa) to head (5e13302).
Report is 8 commits behind head on release-22.x.

Files with missing lines	Patch %	Lines
src/Alert/index.tsx	81.81%	2 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##           release-22.x    #3524      +/-   ##
================================================
+ Coverage         93.48%   93.50%   +0.01%     
================================================
  Files               252      252              
  Lines              4557     4570      +13     
  Branches           1026     1066      +40     
================================================
+ Hits               4260     4273      +13     
  Misses              294      294              
  Partials              3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

bradenmacdonald

Thanks! Was it too difficult to convert these to .ts rather than adding .d.ts files? Generally we've tried to just convert them rather than adding separate definitions.

bradenmacdonald · 2025-04-08T15:12:38Z

src/index.d.ts

@@ -46,13 +46,14 @@ export { default as useToggle, type Toggler, type ToggleHandlers } from './hooks
 export { default as useArrowKeyNavigation, type ArrowKeyNavProps } from './hooks/useArrowKeyNavigationHook';
 export { default as useIndexOfLastVisibleChild } from './hooks/useIndexOfLastVisibleChildHook';
 export { default as useIsVisible } from './hooks/useIsVisibleHook';
+export { default as Alert, ALERT_CLOSE_LABEL_TEXT } from './Alert';
+export { default as breakpoints } from './utils/breakpoints';


Please make the same edits to index.js as well, so the two files stay in sync line for line.

PKulkoRaccoonGang · 2025-04-09T07:59:13Z

Thanks! Was it too difficult to convert these to .ts rather than adding .d.ts files? Generally we've tried to just convert them rather than adding separate definitions.

Thank you! I made the changes, we don't have a .d.ts file for this component.

bradenmacdonald

LGTM! Thanks @PKulkoRaccoonGang :)

openedx-semantic-release-bot · 2025-06-04T15:18:35Z

🎉 This PR is included in version 22.19.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

openedx-semantic-release-bot · 2025-06-12T21:06:37Z

🎉 This PR is included in version 23.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

PKulkoRaccoonGang self-assigned this Apr 8, 2025

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 8, 2025

openedx-webhooks added this to Contributions Apr 8, 2025

github-project-automation bot moved this to Needs Triage in Contributions Apr 8, 2025

feat: added types for <Alert> component

c60ef2b

PKulkoRaccoonGang force-pushed the Peter_Kulko/alert-typing branch from bba66c2 to c60ef2b Compare April 8, 2025 07:42

PKulkoRaccoonGang marked this pull request as ready for review April 8, 2025 07:43

PKulkoRaccoonGang requested review from bradenmacdonald, adamstankiewicz and brian-smith-tcril April 8, 2025 07:53

bradenmacdonald reviewed Apr 8, 2025

View reviewed changes

PKulkoRaccoonGang force-pushed the Peter_Kulko/alert-typing branch from 45b0b4d to 57ead44 Compare April 9, 2025 07:24

PKulkoRaccoonGang marked this pull request as draft April 9, 2025 08:41

refactor: removed index.d.ts

5e13302

PKulkoRaccoonGang force-pushed the Peter_Kulko/alert-typing branch from 57ead44 to 5e13302 Compare April 10, 2025 16:12

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 14, 2025

PKulkoRaccoonGang requested a review from bradenmacdonald April 15, 2025 14:03

PKulkoRaccoonGang marked this pull request as ready for review April 15, 2025 14:03

bradenmacdonald approved these changes Apr 16, 2025

View reviewed changes

adamstankiewicz approved these changes Jun 4, 2025

View reviewed changes

brian-smith-tcril merged commit f3d562f into release-22.x Jun 4, 2025
9 of 10 checks passed

brian-smith-tcril deleted the Peter_Kulko/alert-typing branch June 4, 2025 15:10

github-project-automation bot moved this from Waiting on Author to Done in Contributions Jun 4, 2025

openedx-semantic-release-bot added the released on @22.x label Jun 4, 2025

openedx-semantic-release-bot added the released label Jun 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: added types for <Alert> component #3524

feat: added types for <Alert> component #3524

Uh oh!

PKulkoRaccoonGang commented Apr 8, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Apr 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Apr 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Apr 8, 2025 •

edited

Loading

Uh oh!

bradenmacdonald left a comment

Uh oh!

bradenmacdonald Apr 8, 2025

Uh oh!

PKulkoRaccoonGang Apr 9, 2025

Uh oh!

PKulkoRaccoonGang commented Apr 9, 2025 •

edited

Loading

Uh oh!

bradenmacdonald left a comment

Uh oh!

Uh oh!

openedx-semantic-release-bot commented Jun 4, 2025

Uh oh!

openedx-semantic-release-bot commented Jun 12, 2025

Uh oh!

Uh oh!

feat: added types for <Alert> component #3524

feat: added types for <Alert> component #3524

Uh oh!

Conversation

PKulkoRaccoonGang commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Merge Checklist

Post-merge Checklist

Uh oh!

openedx-webhooks commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for paragon-openedx-v22 ready!

Uh oh!

codecov bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

PKulkoRaccoonGang Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

PKulkoRaccoonGang commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openedx-semantic-release-bot commented Jun 4, 2025

Uh oh!

openedx-semantic-release-bot commented Jun 12, 2025

Uh oh!

Uh oh!

PKulkoRaccoonGang commented Apr 8, 2025 •

edited

Loading

openedx-webhooks commented Apr 8, 2025 •

edited

Loading

netlify bot commented Apr 8, 2025 •

edited

Loading

codecov bot commented Apr 8, 2025 •

edited

Loading

PKulkoRaccoonGang commented Apr 9, 2025 •

edited

Loading