Add TypeScript types for <Overlay>, <OverlayTrigger>, <Tooltip>, <IconButton> #3100

bradenmacdonald · 2024-06-17T18:46:01Z

Description

This adds types for <Overlay>, <OverlayTrigger>, <Tooltip>, and <IconButton> by converting their implementations from .jsx to .tsx.

This also fixes a number of random type errors that then showed up in the various test files, and makes some minor cleanups to <Chip> related code, such as removing // @ts-ignore directives now that we have typings available for <IconButton>.

Deploy Preview

https://deploy-preview-3100--paragon-openedx.netlify.app/

Merge Checklist

n/a for this type of internal change.

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 · 2024-06-17T18:46:06Z

Thanks for the pull request, @bradenmacdonald! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

netlify · 2024-06-17T18:46:16Z

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`4aee81f`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/66881ed9c07cc700084d9c5b
😎 Deploy Preview	https://deploy-preview-3100--paragon-openedx.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 · 2024-06-17T19:01:48Z

Codecov Report

Attention: Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.25%. Comparing base (cdec543) to head (4aee81f).
Report is 177 commits behind head on master.

Files with missing lines	Patch %	Lines
src/Overlay/index.tsx	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3100      +/-   ##
==========================================
+ Coverage   93.20%   93.25%   +0.04%     
==========================================
  Files         249      249              
  Lines        4359     4388      +29     
  Branches     1034     1037       +3     
==========================================
+ Hits         4063     4092      +29     
  Misses        290      290              
  Partials        6        6

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

brian-smith-tcril

This is wonderful! I'm super happy to see components cleaned up like this!

LGTM!

brian-smith-tcril · 2024-06-20T18:05:09Z

www/src/components/CodeBlock.tsx

@@ -37,7 +37,7 @@ const {

 export type CollapsibleLiveEditorTypes = {
  children: React.ReactNode;
-  clickToCopy: (arg: string) => void;


@adamstankiewicz do you know why arg: string was in here before?

Most likely, we previously passed some kind of parameter here, but now this parameter does not exist.
Good catch! 💯

PKulkoRaccoonGang

This looks great, left some suggestions

src/Chip/ChipIcon.tsx

PKulkoRaccoonGang · 2024-07-02T13:00:28Z

www/src/components/CodeBlock.tsx

@@ -37,7 +37,7 @@ const {

 export type CollapsibleLiveEditorTypes = {
  children: React.ReactNode;
-  clickToCopy: (arg: string) => void;


Most likely, we previously passed some kind of parameter here, but now this parameter does not exist.
Good catch! 💯

bradenmacdonald · 2024-07-05T16:38:12Z

@PKulkoRaccoonGang Thanks for the review! I made those suggested changes.

bradenmacdonald · 2024-07-07T09:31:54Z

@brian-smith-tcril or @PKulkoRaccoonGang could one of you please merge this at your convenience? :)

openedx-webhooks · 2024-07-07T11:20:36Z

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

PKulkoRaccoonGang · 2024-07-07T11:21:06Z

@bradenmacdonald 🚀

…, <IconButton> (#3100) * feat: add typings for <Overlay> and <OverlayTrigger> * feat: add typings for <Tooltip> * feat: add typings for <IconButton> * chore: typing cleanups for <Chip> code * feat: slightly more detailed types for <Chip/ChipIcon> - per review

bradenmacdonald · 2024-07-08T09:03:54Z

Thanks @PKulkoRaccoonGang !

openedx-semantic-release-bot · 2024-07-17T12:26:39Z

🎉 This PR is included in version 22.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

…, <IconButton> (#3100) * feat: add typings for <Overlay> and <OverlayTrigger> * feat: add typings for <Tooltip> * feat: add typings for <IconButton> * chore: typing cleanups for <Chip> code * feat: slightly more detailed types for <Chip/ChipIcon> - per review

openedx-semantic-release-bot · 2024-12-11T18:50:32Z

🎉 This PR is included in version 23.0.0-alpha.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

bradenmacdonald added 2 commits June 14, 2024 14:29

feat: add typings for <Overlay> and <OverlayTrigger>

b3613cc

feat: add typings for <Tooltip>

ef4990c

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 17, 2024

bradenmacdonald added 2 commits June 17, 2024 11:50

feat: add typings for <IconButton>

1b642a6

chore: typing cleanups for <Chip> code

4cd7029

bradenmacdonald force-pushed the braden/more-types branch from bf2b998 to 4cd7029 Compare June 17, 2024 18:51

bradenmacdonald requested review from adamstankiewicz and brian-smith-tcril June 17, 2024 20:13

brian-smith-tcril approved these changes Jun 20, 2024

View reviewed changes

PKulkoRaccoonGang reviewed Jul 2, 2024

View reviewed changes

feat: slightly more detailed types for <Chip/ChipIcon> - per review

4aee81f

PKulkoRaccoonGang approved these changes Jul 7, 2024

View reviewed changes

PKulkoRaccoonGang merged commit 8985c07 into openedx:master Jul 7, 2024
10 checks passed

PKulkoRaccoonGang assigned bradenmacdonald Jul 7, 2024

bradenmacdonald deleted the braden/more-types branch July 8, 2024 09:03

openedx-semantic-release-bot added the released label Jul 17, 2024

openedx-semantic-release-bot added the released on @alpha label Dec 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add TypeScript types for <Overlay>, <OverlayTrigger>, <Tooltip>, <IconButton> #3100

Add TypeScript types for <Overlay>, <OverlayTrigger>, <Tooltip>, <IconButton> #3100

bradenmacdonald commented Jun 17, 2024 •

edited

Loading

openedx-webhooks commented Jun 17, 2024

netlify bot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

brian-smith-tcril left a comment

brian-smith-tcril Jun 20, 2024

PKulkoRaccoonGang Jul 2, 2024

PKulkoRaccoonGang left a comment

PKulkoRaccoonGang Jul 2, 2024

bradenmacdonald commented Jul 5, 2024

bradenmacdonald commented Jul 7, 2024

openedx-webhooks commented Jul 7, 2024

PKulkoRaccoonGang commented Jul 7, 2024

bradenmacdonald commented Jul 8, 2024

openedx-semantic-release-bot commented Jul 17, 2024

openedx-semantic-release-bot commented Dec 11, 2024

Add TypeScript types for <Overlay>, <OverlayTrigger>, <Tooltip>, <IconButton> #3100

Add TypeScript types for <Overlay>, <OverlayTrigger>, <Tooltip>, <IconButton> #3100

Conversation

bradenmacdonald commented Jun 17, 2024 • edited Loading

Description

Deploy Preview

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Jun 17, 2024

netlify bot commented Jun 17, 2024 • edited Loading

✅ Deploy Preview for paragon-openedx ready!

codecov bot commented Jun 17, 2024 • edited Loading

Codecov Report

brian-smith-tcril left a comment

Choose a reason for hiding this comment

brian-smith-tcril Jun 20, 2024

Choose a reason for hiding this comment

PKulkoRaccoonGang Jul 2, 2024

Choose a reason for hiding this comment

PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

PKulkoRaccoonGang Jul 2, 2024

Choose a reason for hiding this comment

bradenmacdonald commented Jul 5, 2024

bradenmacdonald commented Jul 7, 2024

openedx-webhooks commented Jul 7, 2024

PKulkoRaccoonGang commented Jul 7, 2024

bradenmacdonald commented Jul 8, 2024

openedx-semantic-release-bot commented Jul 17, 2024

openedx-semantic-release-bot commented Dec 11, 2024

bradenmacdonald commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading