Skip to content
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

[BD-46] feat: add i18n support for ProductTour Checkpoint sr-only message #2758

Merged

Conversation

khudym
Copy link
Contributor

@khudym khudym commented Oct 27, 2023

Description

Add i18n support for ProductTour Checkpoint sr-only message
Issue

Deploy Preview

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

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 add wittjeff and adamstankiewicz as reviewers on this 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.

@netlify
Copy link

netlify bot commented Oct 27, 2023

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit ae63a66
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/6540d744202217000861e0e4
😎 Deploy Preview https://deploy-preview-2758--paragon-openedx.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 site configuration.

@openedx-webhooks
Copy link

Thanks for the pull request, @khudym!

When this pull request is ready, tag your edX technical lead.

@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Oct 27, 2023
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (64611f7) 92.82% compared to head (ae63a66) 92.83%.
Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2758   +/-   ##
=======================================
  Coverage   92.82%   92.83%           
=======================================
  Files         235      235           
  Lines        4237     4240    +3     
  Branches     1029     1029           
=======================================
+ Hits         3933     3936    +3     
  Misses        300      300           
  Partials        4        4           
Files Coverage Δ
src/ProductTour/Checkpoint.jsx 77.14% <ø> (ø)

... and 1 file with indirect coverage changes

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

Comment on lines 100 to 104
<FormattedMessage
id="pgn.checkpoint.sr-only.message"
defaultMessage={`Top of step ${index + 1}`}
description="Screen-reader message to indicate the user's position in a sequence of checkpoints."
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

This not the right way to translate messages with variables in it, the correct syntax is as follows (see docs):

<FormattedMessage
  id="pgn.ProductTour.Checkpoint.position-text" // should change the id as well, we try to follow <component>.<subComponent> pattern in our ids
  defaultMessage="Top of step {step}"
  value={{ step: index + 1 }}
  description="Screen-reader message to indicate the user's position in a sequence of checkpoints."
/>

<span className="sr-only">
<FormattedMessage
id="pgn.checkpoint.sr-only.message"
defaultMessage={`Top of step ${index + 1}`}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do I need to add keys for this translation to the i18n folder?

@viktorrusakov viktorrusakov linked an issue Oct 30, 2023 that may be closed by this pull request
@viktorrusakov viktorrusakov merged commit f124792 into openedx:master Nov 1, 2023
8 checks passed
@openedx-webhooks
Copy link

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

@openedx-semantic-release-bot

🎉 This PR is included in version 21.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 22.0.0-alpha.15 🎉

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
blended PR is managed through 2U's blended developmnt program released on @alpha released
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

src/ProductTour/Checkpoint.jsx i18n support
5 participants