Skip to content

feat: convert ProgressBar component to TypeScript#4139

Open
brianjbuck-wgu wants to merge 1 commit intoopenedx:release-23.xfrom
WGU-Open-edX:feat/convert-progressbar-to-typescript
Open

feat: convert ProgressBar component to TypeScript#4139
brianjbuck-wgu wants to merge 1 commit intoopenedx:release-23.xfrom
WGU-Open-edX:feat/convert-progressbar-to-typescript

Conversation

@brianjbuck-wgu
Copy link

Description

Convert the ProgressBar component from JavaScript (.jsx) to TypeScript (.tsx) as part of the ongoing migration tracked in #3739.

This change eliminates deprecated React APIs (PropTypes and defaultProps) to support the eventual React 19 upgrade and provides build-time type safety.

Changes:

  • Rename index.jsxindex.tsx, utils.jsutils.ts, and test files to .tsx/.ts
  • Replace PropTypes with ProgressBarAnnotatedProps TypeScript interface (with JSDoc comments preserving prop descriptions)
  • Replace defaultProps with parameter defaults in the function signature
  • Type useRef calls, utility functions, and component props
  • Remove // @ts-ignore comment from src/index.ts
  • Export ProgressBarAnnotatedProps type for consumers

Deploy Preview

Check the ProgressBar component page in the deploy preview to verify props documentation renders correctly.

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. (No visual changes — TypeScript conversion only)
  • Does your change adhere to the documented style conventions? (No style changes)
  • 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? (All 14 existing tests pass unchanged)
  • 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. (No a11y impact — TypeScript conversion only)

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.

Replace PropTypes and defaultProps with TypeScript interfaces and
parameter defaults to support React 19 migration. Resolves openedx#3739.

- Rename .jsx/.js files to .tsx/.ts
- Add ProgressBarAnnotatedProps interface with JSDoc comments
- Type refs, utility functions, and component props
- Remove ts-ignore comment from src/index.ts
- Export ProgressBarAnnotatedProps type for consumers

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openedx-webhooks
Copy link

Thanks for the pull request, @brianjbuck-wgu!

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

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.

Details
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
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for paragon-openedx-v23 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e494358
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/699e1ccdf673380008a16f6f
😎 Deploy Preview https://deploy-preview-4139--paragon-openedx-v23.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 24, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Feb 24, 2026
@brianjbuck-wgu
Copy link
Author

Claude Code Session Summary — Feb 24, 2026

Objective

Convert the ProgressBar component from JavaScript to TypeScript as part of the Paragon design system's migration (issue#3739).

Work Completed

1. Converted utils.jsutils.ts

  • Added type annotations to placeInfoAtZero (React.RefObject, return type boolean)
  • Added type annotations to getOffsetStyles (typed parameters and return type)

2. Converted index.jsxindex.tsx

  • Defined ProgressBarAnnotatedProps interface with JSDoc comments
  • Replaced PropTypes/defaultProps with TypeScript types and parameter defaults
  • Typed refs as useRef<HTMLDivElement>(null)
  • Created ProgressBarComponent interface for the compound component pattern
  • Exported the props type for consumers

3. Converted test files

  • Renamed ProgressBar.test.jsx.tsx and utils.test.js.ts
  • Added as any casts for mock ref objects
  • Fixed window.getComputedStyle mock typing

4. Updated src/index.ts

  • Removed // @ts-ignore comment
  • Added ProgressBarAnnotatedProps type export

5. Bug fix during conversion

  • Fixed a TS error in the useEffect cleanup function — the && short-circuit return could produce null, which isn't a valid EffectCallback return
  • Converted to an explicit if block

Verification

  • Type-check: npm run type-check passes cleanly
  • Tests: All 14 existing tests pass
  • Lint: ESLint passed via pre-commit hook

@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Feb 24, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Feb 24, 2026
@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.40%. Comparing base (dfc69e2) to head (e494358).
⚠️ Report is 7 commits behind head on release-23.x.

Additional details and impacted files
@@               Coverage Diff                @@
##           release-23.x    #4139      +/-   ##
================================================
+ Coverage         94.39%   94.40%   +0.01%     
================================================
  Files               242      242              
  Lines              4296     4305       +9     
  Branches           1020     1022       +2     
================================================
+ Hits               4055     4064       +9     
  Misses              237      237              
  Partials              4        4              

☔ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants