Skip to content

refactor(i18n): move updateLanguage to runtime as shared funtionality - #289

Open
dcoa wants to merge 6 commits into
openedx:mainfrom
eduNEXT:dcoa/lang-selec-refactor
Open

refactor(i18n): move updateLanguage to runtime as shared funtionality#289
dcoa wants to merge 6 commits into
openedx:mainfrom
eduNEXT:dcoa/lang-selec-refactor

Conversation

@dcoa

@dcoa dcoa commented Aug 14, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

The current PR aims to consolidate a reusable feature that enables updating the language preference across different UI components, ensuring consistent behavior.

What changes were implemented?

  • Moved the updateSiteLanguage function from shell/footer to runtime/i18n, making it reusable across any component in the site. For example, it can now be used by the LanguageMenu in the Footer and the Language Preference Selector in the Account App.

  • Added two optional configuration properties to the i18n runtime:

    • defaultLanguage (string, default: 'en'): Defines the fallback locale when a user's preferred locale is not supported. Open edX provides the LANGUAGE_CODE setting to configure the platform's default language (for any non-English site), but this setting is not currently read by the client-side code. This property provides equivalent flexibility on the client side.
    • supportedLanguages (string[], default: []): Defines an allowlist of supported language codes. When non-empty, only these languages are displayed in the language picker and considered supported during locale resolution. An empty array means that all loaded locales are considered supported.

  • Updated handleRtl() to set both the lang and dir attributes on <html>. Previously, the lang attribute was not being updated. Updating lang ensures browsers, screen readers, and other accessibility tools correctly identify the page's language and provide appropriate language-specific behavior.

  • Performs a optimistic UI update, updateLocale changes the UI, then the user preference and the cookie is updated via API.

  • Displays a Toast message when the preference language API or user preference API fails.

How to test

  • Use the test-site
  • Add the two new optional configuration for test limited dropdown options displayed and non-English default language. Example:
// ...
    "defaultLanguage": "es-419",
    "supportedLanguages": ["es-419", "ar"],
// ...
  • You will need to update the i18n folder to expose the translations (you can get support of AI). For example:
import es419 from './messages/es-419.json';
import ar from './messages/ar.json';
import ptBR from './messages/pt_BR.json';

export default [
  {
    'es-419': es419,
    ar,
    'pt-br': ptBR,
  },
];
  • Load the testing application and verify the html and the language selector displays defaultLanguage
  • Change the language and verify the UI is updated and the cookie is set with the selected language.
  • Log in/ Log out and verify the cookie is not duplicated.
  • Test the Error message is visible if the API fails.
image
Screencast.from.2026-08-14.23-51-01.webm

Additional Information

LLM use

Supported by Opencode - Deepseek V4

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 14, 2026
@openedx-webhooks

openedx-webhooks commented Aug 14, 2026 •
edited
Loading

Copy link
Copy Markdown

Thanks for the pull request, @dcoa!

This repository is currently maintained by @openedx/axim-engineering.

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.

Details
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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 14, 2026
@dcoa dcoa changed the title Dcoa/lang selec refactor refactor: move updateLanguage to runtime as shared funtionality Aug 14, 2026
@dcoa
dcoa force-pushed the dcoa/lang-selec-refactor branch from a7923f1 to 93bf13e Compare August 14, 2026 10:23
@dcoa
dcoa force-pushed the dcoa/lang-selec-refactor branch from 4b9b67f to 3432147 Compare August 14, 2026 11:13
@dcoa dcoa changed the title refactor: move updateLanguage to runtime as shared funtionality refactor(i18n): move updateLanguage to runtime as shared funtionality Aug 14, 2026
@dcoa
dcoa marked this pull request as ready for review August 14, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arbrandes arbrandes Awaiting requested review from arbrandes
@brian-smith-tcril brian-smith-tcril Awaiting requested review from brian-smith-tcril

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Needs Triage

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Make site language switching a supported runtime API

2 participants

@dcoa @openedx-webhooks