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/src/components/common/search.tsx #3659

Merged
merged 2 commits into from
Oct 13, 2024

Conversation

Dreptschar
Copy link
Contributor

Translation support for packages/desktop-client/components/common/search

Copy link

netlify bot commented Oct 13, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 9c31fde
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/670bb9aa4a00060008b487d7
😎 Deploy Preview https://deploy-preview-3659.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 13, 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.33 MB → 5.33 MB (+274 B) +0.00%
Changeset
File Δ Size
node_modules/es-define-property/index.js 📈 +210 B (+60.00%) 350 B → 560 B
src/components/common/Search.tsx 📈 +37 B (+2.20%) 1.64 kB → 1.68 kB
node_modules/has-property-descriptors/index.js 📈 +9 B (+1.57%) 573 B → 582 B
node_modules/call-bind/index.js 📈 +9 B (+0.85%) 1.04 kB → 1.05 kB
node_modules/define-data-property/index.js 📈 +9 B (+0.39%) 2.24 kB → 2.25 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.34 MB → 3.34 MB (+274 B) +0.01%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/AppliedFilters.js 21.31 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.55 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 13, 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%

@Dreptschar Dreptschar changed the title [WIP] Translation: desktop-client/src/components/common/search.tsx Translation: desktop-client/src/components/common/search.tsx Oct 13, 2024
Copy link
Contributor

coderabbitai bot commented Oct 13, 2024

Walkthrough

The pull request introduces a modification to the Search component located in packages/desktop-client/src/components/common/Search.tsx. A new import statement for the useTranslation hook from the react-i18next library is added. The useTranslation hook is utilized within the Search component to obtain the translation function t. This function is employed to dynamically set the title prop of the View component that contains the Button for clearing the search term. The title is updated from a static string "Clear search term" to a dynamic call t('Clear search term'). No other changes to the component's logic or structure are included in this pull request, and there are no alterations to the declarations of exported or public entities.

Possibly related PRs

  • Marked files for translation #3444: The changes in this PR also involve integrating the react-i18next library for internationalization, specifically using the useTranslation hook and the Trans component, which aligns with the changes made in the main PR regarding the use of the useTranslation hook in the Search component.

Suggested labels

:sparkles: Merged


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 (2)
packages/desktop-client/src/components/common/Search.tsx (2)

Line range hint 20-20: Consider translating the placeholder text

While the "Clear search term" string is now translated, the placeholder prop is still passed as a static string. For consistency and complete internationalization, consider translating the placeholder text as well.

You could modify the component to accept a translation key for the placeholder and apply the translation function like this:

 type SearchProps = {
   inputRef?: Ref<HTMLInputElement>;
   value: string;
   onChange: (value: string) => void;
-  placeholder: string;
+  placeholderKey: string;
   isInModal?: boolean;
   width?: number;
 };

 export function Search({
   inputRef,
   value,
   onChange,
-  placeholder,
+  placeholderKey,
   isInModal = false,
   width = 250,
 }: SearchProps) {
   const { t } = useTranslation();
   // ...
-  placeholder={placeholder}
+  placeholder={t(placeholderKey)}
   // ...
 }

This change would ensure that the placeholder text is also internationalized.

Also applies to: 33-33


Line range hint 1-93: Consider a more comprehensive approach to internationalization

While the current changes successfully implement translation for the "Clear search term" string, there are opportunities for a more thorough internationalization of the component:

  1. As mentioned earlier, translate the placeholder text.
  2. Review the component for any other user-facing strings that might need translation.
  3. Update the component's props and types to reflect the internationalization changes, such as accepting translation keys instead of direct strings.
  4. Consider extracting all translatable strings into a separate translation file or constant object for easier management and consistency.

These suggestions would result in a more robust and maintainable internationalized component. Would you like assistance in implementing these improvements?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f898171 and 9c31fde.

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

2-2: LGTM: Import of useTranslation hook

The import of the useTranslation hook from 'react-i18next' is correctly placed and aligns with the PR objective of implementing translation support for this component.


28-28: LGTM: Usage of useTranslation hook and translation function

The useTranslation hook is correctly used to obtain the translation function, and it's properly applied to the "Clear search term" string. This implementation supports the internationalization of the component as intended.

Also applies to: 60-60


Line range hint 1-93: Summary of review and next steps

The changes successfully introduce basic translation support for the Search component, aligning with the PR objectives. The implementation is correct but could be more comprehensive.

Next steps to consider:

  1. Translate the placeholder text.
  2. Review and translate any other user-facing strings in the component.
  3. Update component props and types to better support internationalization.
  4. Extract translatable strings for easier management.

These improvements would result in a fully internationalized component, enhancing the overall user experience across different languages.

@MikesGlitch MikesGlitch self-assigned this Oct 13, 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.

Nice! Thanks.

@MikesGlitch MikesGlitch merged commit 130f357 into actualbudget:master Oct 13, 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