feat: add typings for hooks

[bradenmacdonald]

Description

This PR adds typescript types for the various hooks that Paragon provides: useWindowSize, useToggle, useArrowKeyNavigation, useIndexOfLastVisibleChild, and useIsVisible. There should be no changes other than to the typings.

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

Merge Checklist

n/a - doesn't apply to this type of PR.

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]

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

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

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/paragon-working-group. Tag them in a comment and let them know that your changes are ready for review.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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

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

[netlify[bot]]

❌ Deploy Preview for paragon-openedx failed.

Built without sensitive environment variables

Name	Link
🔨 Latest commit	9c101775b302a037d953d41b78eb1f6a99eaddec
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/668bf546222dca0008e0e070

[bradenmacdonald]

OK, this is very weird. Without any the other changes, merely renaming useIsVisible.jsx to useIsVisible.tsx totally breaks the build of the Paragon docs site (in dev mode, if I restart it, I cannot access the site). But the error is very obscure.

[mphilbrick211]

@bradenmacdonald just checking in to see if this is still in progress!

[bradenmacdonald]

@mphilbrick211 Thanks for the reminder. I lost momentum on this but now that I have @adamstankiewicz's feedback I would like to pick it up again soon!

[bradenmacdonald]

Update: I tried to move this forward, but I'm blocked on some strange webpack bug where it is confusing useToggle.mdx and useToggle.tsx, returning the MDX content when I import the TypeScript file. I believe the only way to fix it is likely upgrading gatsby.

[brian-smith-tcril]

Update: I tried to move this forward, but I'm blocked on some strange webpack bug where it is confusing useToggle.mdx and useToggle.tsx, returning the MDX content when I import the TypeScript file. I believe the only way to fix it is likely upgrading gatsby.

I pulled the branch and got the docs site to build/run locally with a less than ideal workaround. I added Doc to the filenames of all the .mdx files in the hooks directory. Unfortunately that led to the url for those pages also having doc in them (example: http://localhost:8000/components/hooks/usetoggledoc/)

I'll do a little more digging to see if I can come up with a better option.

[brian-smith-tcril]

I tried another thing which seems to work (I haven't clicked around all the docs site pages yet)

diff --git a/www/gatsby-config.js b/www/gatsby-config.js
index e3976a0b2c..c0ae5209a2 100644
--- a/www/gatsby-config.js
+++ b/www/gatsby-config.js
@@ -34,6 +34,7 @@ const plugins = [
     },
   },
   'gatsby-plugin-react-helmet',
+  'gatsby-plugin-typescript',
   {
     resolve: 'gatsby-plugin-manifest',
     options: {

[codecov[bot]]

Codecov Report

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

Project coverage is 93.43%. Comparing base (5c53137) to head (a3fea9e). Report is 14 commits behind head on release-22.x.

Files with missing lines	Patch %	Lines
src/hooks/useArrowKeyNavigation.tsx	80.00%	2 Missing :warning:

Additional details and impacted files

@@               Coverage Diff                @@
##           release-22.x    #3125      +/-   ##
================================================
+ Coverage         93.42%   93.43%   +0.01%     
================================================
  Files               250      251       +1     
  Lines              4515     4522       +7     
  Branches           1017     1057      +40     
================================================
+ Hits               4218     4225       +7     
+ Misses              294      290       -4     
- Partials              3        7       +4     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[netlify[bot]]

✅ Deploy Preview for paragon-openedx-v22 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	a3fea9e291c5b3fc28ccd4be154d5d5695cd8009
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx-v22/deploys/6760a4443d05cd0008c96890
😎 Deploy Preview	https://deploy-preview-3125--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.

[bradenmacdonald]

@adamstankiewicz Sorry for the long delay in addressing your review, and thanks SO much to @brian-smith-tcril for helping me figure out the very obscure bug that had me stumped.

This is ready for another review !

[openedx-semantic-release-bot]

:tada: This PR is included in version 22.13.0 :tada:

The release is available on:

• npm package (@release-22.x dist-tag)
• GitHub release

Your semantic-release bot :package::rocket:

[openedx-semantic-release-bot]

:tada: This PR is included in version 23.2.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: