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

Replace Link with LocaleLink for localization support #452

Merged
merged 4 commits into from
Dec 22, 2024
Merged

Conversation

ttizze
Copy link
Owner

@ttizze ttizze commented Dec 22, 2024

This pull request updates the application to use LocaleLink instead of the standard Link component from Remix. This change is made across various pages to ensure that links are properly localized based on the user's locale. Additionally, a new NavLocaleLink component is introduced to handle navigation links with locale support. This enhances the user experience by providing localized routing throughout the application.

Summary by CodeRabbit

  • New Features
    • Introduced LocaleLink and NavLocaleLink components for localized navigation.
  • Improvements
    • Replaced existing Link and NavLink components with LocaleLink and NavLocaleLink across various components for enhanced localization.
  • Bug Fixes
    • Ensured that navigation links in the footer, header, and various pages now reflect the correct locale.
  • Chores
    • Updated imports and component usage to incorporate new localized link components throughout the application.

Copy link

coderabbitai bot commented Dec 22, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a comprehensive localization strategy for navigation links across the web application. By creating new components LocaleLink and NavLocaleLink, the project replaces standard Remix Link and NavLink components with locale-aware alternatives. These new components automatically prepend the current locale to navigation paths, ensuring consistent and context-aware routing throughout the application. The changes span multiple files, systematically updating link components to support internationalization without altering core component logic.

Changes

File Path Change Summary
web/app/components/BaseHeaderLayout.tsx Replaced Link and NavLink with LocaleLink and NavLocaleLink
web/app/components/LocaleLink.tsx New component for locale-aware link navigation
web/app/components/NavLocaleLink.tsx New component for locale-aware navigation links
web/app/routes/* Updated multiple route files to use LocaleLink and NavLocaleLink

Sequence Diagram

sequenceDiagram
    participant User
    participant App
    participant LocaleLink
    participant Router
    
    User->>App: Navigate
    App->>LocaleLink: Request link
    LocaleLink->>LocaleLink: Detect current locale
    LocaleLink->>Router: Construct localized path
    Router-->>LocaleLink: Return localized URL
    LocaleLink-->>App: Render localized link
    App->>User: Display localized navigation
Loading

Possibly related PRs

  • pageCard統一 #449: Changes in the PageCard component related to localized navigation using LocaleLink

Poem

🐰 Locale Links, a Rabbit's Delight
Hopping through paths, both left and right
No more static routes that feel so plain
With locales dancing, we break the chain
Navigation smart, with context bright! 🌍


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b11e527 and 38310a5.

📒 Files selected for processing (17)
  • web/app/components/BaseHeaderLayout.tsx (5 hunks)
  • web/app/components/LocaleLink.tsx (1 hunks)
  • web/app/components/NavLocaleLink.tsx (1 hunks)
  • web/app/components/PageCard.tsx (3 hunks)
  • web/app/routes/$locale+/auth/login/route.tsx (2 hunks)
  • web/app/routes/$locale+/privacy.tsx (2 hunks)
  • web/app/routes/$locale+/search/route.tsx (2 hunks)
  • web/app/routes/$locale+/terms/route.tsx (2 hunks)
  • web/app/routes/$locale+/user.$userName+/components/PageActionsDropdown.tsx (2 hunks)
  • web/app/routes/$locale+/user.$userName+/index.tsx (2 hunks)
  • web/app/routes/$locale+/user.$userName+/page+/$slug+/components/ContentWithTranslations.tsx (3 hunks)
  • web/app/routes/$locale+/user.$userName+/page+/$slug+/components/sourceTextAndTranslationSection/SourceTextAndTranslationSection.tsx (2 hunks)
  • web/app/routes/$locale+/user.$userName+/page+/$slug+/components/sourceTextAndTranslationSection/TranslationSection.tsx (2 hunks)
  • web/app/routes/$locale+/user.$userName+/page-management/components/PageManagementTab.tsx (2 hunks)
  • web/app/routes/resources+/footer.tsx (1 hunks)
  • web/app/routes/resources+/header.tsx (3 hunks)
  • web/app/routes/resources+/translation-list-item.tsx (2 hunks)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@ttizze ttizze merged commit 2263026 into main Dec 22, 2024
4 of 5 checks passed
@ttizze ttizze deleted the feature/lang3 branch December 22, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

1 participant