Skip to content

feat: adding i18n support for modal dialog close button label #3624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

jacobo-dominguez-wgu
Copy link
Contributor

Description

#3529
Adding i18n support for the close button label on the modal dialog component
Recomendations on unit tests were ignored since those are not user facing texts.
Captura de pantalla 2025-05-29 a la(s) 3 01 31 p m

release-23 pr

Deploy Preview

https://deploy-preview-3618--paragon-openedx-v23.netlify.app

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 2, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @jacobo-dominguez-wgu!

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.

Copy link

netlify bot commented Jun 2, 2025

Deploy Preview for paragon-openedx-v22 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 21c57bb
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v22/deploys/683f12c602bb4f0008f449a3
😎 Deploy Preview https://deploy-preview-3624--paragon-openedx-v22.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.

Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.10%. Comparing base (58758d3) to head (21c57bb).
Report is 5 commits behind head on release-22.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           release-22.x    #3624   +/-   ##
=============================================
  Coverage         93.09%   93.10%           
=============================================
  Files               251      252    +1     
  Lines              4592     4597    +5     
  Branches           1038     1038           
=============================================
+ Hits               4275     4280    +5     
  Misses              314      314           
  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.

@@ -64,14 +66,16 @@ function ModalDialog({
size = 'md',
variant = 'default',
hasCloseButton = true,
closeLabel = MODAL_DIALOG_CLOSE_LABEL,
closeLabel,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With MODAL_DIALOG_CLOSE_LABEL no longer being used I think it makes sense to remove it completely. I checked and it doesn't seem like it is being imported anywhere in the Open edX GH org https://github.com/search?q=org%3Aopenedx%20MODAL_DIALOG_CLOSE_LABEL&type=code

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jun 3, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 3, 2025
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this!

@brian-smith-tcril brian-smith-tcril merged commit 2346e92 into openedx:release-22.x Jun 4, 2025
10 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jun 4, 2025
@openedx-semantic-release-bot

🎉 This PR is included in version 22.20.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 23.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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 released on @22.x released
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants