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

Translation: desktop-client/components/payees/ManagePayees #3623

Merged
merged 10 commits into from
Oct 14, 2024

Conversation

glorenzen
Copy link
Contributor

Add translation support for packages/desktop-client/src/components/payees/ManagePayees.tsx.

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit a28cec8
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/670d88853a127d000841e6f8
😎 Deploy Preview https://deploy-preview-3623.demo.actualbudget.org
📱 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.

Copy link
Contributor

github-actions bot commented Oct 10, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
9 5.34 MB → 5.34 MB (-18 B) -0.00%
Changeset
File Δ Size
src/components/payees/ManagePayees.tsx 📉 -18 B (-0.24%) 7.42 kB → 7.41 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
static/js/index.js 3.34 MB → 3.34 MB (-18 B) -0.00%

Unchanged

Asset File Size % Changed
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/AppliedFilters.js 21.31 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/narrow.js 82.58 kB 0%
static/js/wide.js 243.06 kB 0%
static/js/ReportRouter.js 1.51 MB 0%

Copy link
Contributor

github-actions bot commented Oct 10, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.26 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.26 MB 0%

@glorenzen glorenzen changed the title [WIP] Translation: desktop-client/components/payees/ManagePayees Translation: desktop-client/components/payees/ManagePayees Oct 10, 2024
@glorenzen glorenzen marked this pull request as ready for review October 10, 2024 22:19
@glorenzen
Copy link
Contributor Author

I'm not sure why the compare check failed, but everything else should be in order.

Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The pull request introduces internationalization features to the ManagePayees.tsx component within the desktop client. It incorporates the useTranslation hook from the react-i18next library, which replaces hardcoded strings with translatable text using the t() function. Key modifications include updating the button that displays the number of selected payees to utilize t('No payees selected'), and adjusting the pluralization logic for the count of selected payees to use t(plural(...)). Additionally, the button for toggling orphaned payees visibility has been updated to use translated strings, and the search input's placeholder is now set to placeholder={t('Filter payees...')}. These changes enhance the component's multilingual capabilities while maintaining its existing functionality and logic.

Possibly related PRs

Suggested labels

#sparkles: Merged

Suggested reviewers

  • matt-fidd

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6339f33 and f52f269.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/payees/ManagePayees.tsx (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/desktop-client/src/components/payees/ManagePayees.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
packages/desktop-client/src/components/payees/ManagePayees.tsx (3)

193-196: LGTM with a minor suggestion: Good use of translation function

The translation function t is correctly used for both the "No payees selected" case and the plural form of "payee"/"payees". This approach will work well for internationalization.

However, for even better i18n support, consider using a single translation key that includes both the number and the noun. This allows for more flexibility in languages with complex plural rules.

Consider refactoring to use a single translation key:

t('{{count}} payee selected', { count: selected.items.size })

This approach allows the translation file to handle pluralization and word order differences across languages more effectively.


229-236: Improvement needed: Refactor for better i18n support

While the t function is correctly used for translations, the current implementation can be improved for better internationalization support.

Consider the following improvements:

  1. Use a single translation key with pluralization for the "Show X unused payee(s)" text:
t('Show {{count}} unused payee', { count: orphanedPayees.length })
  1. Move the ternary operator outside of the t function call:
orphanedOnly
  ? t('Show all payees')
  : t('Show {{count}} unused payee', { count: orphanedPayees.length })

These changes will allow for more flexible translations across different languages, especially those with complex plural rules.


Line range hint 270-270: Suggestion: Translate "No payees" text

For consistency, the "No payees" text in the empty state should also be translated.

Replace:

No payees

with:

{t('No payees')}

This will ensure that all user-facing strings in the component are translatable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e37a42f and 6339f33.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3623.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/payees/ManagePayees.tsx (4 hunks)
🧰 Additional context used
🔇 Additional comments (3)
packages/desktop-client/src/components/payees/ManagePayees.tsx (3)

8-8: LGTM: Correct import of useTranslation hook

The import of useTranslation from 'react-i18next' is correctly added, which is essential for implementing internationalization in this component.


96-96: LGTM: Proper usage of useTranslation hook

The useTranslation hook is correctly used to obtain the t function, which will be used for translating strings throughout the component.


242-242: LGTM: Correct translation of placeholder text

The placeholder text for the search input is correctly translated using the t function. This is a good practice for ensuring all user-facing strings are translatable.

@MikesGlitch MikesGlitch self-assigned this Oct 14, 2024
Copy link
Contributor

@MikesGlitch MikesGlitch left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks :shipit:

@MikesGlitch MikesGlitch merged commit b253246 into actualbudget:master Oct 14, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants