mirror of
https://github.com/mue/mue.git
synced 2026-07-15 13:03:55 +02:00
feat(translation): refactor translation system to use useT hook for reactive updates
This commit is contained in:
@@ -1,43 +1,96 @@
|
||||
# Translation System
|
||||
|
||||
## Using Reactive Translations
|
||||
## Refactored Translation System ✨
|
||||
|
||||
The app now supports instant language switching without page refresh!
|
||||
The app now has a robust, centralized translation system that updates instantly without page refresh!
|
||||
|
||||
### For new components
|
||||
### Using Translations (New API)
|
||||
|
||||
Use the `useMessage` hook for reactive translations:
|
||||
**Recommended approach** - Use the `useT()` hook:
|
||||
|
||||
```jsx
|
||||
import { useMessage } from 'contexts/TranslationContext';
|
||||
import { useT } from 'contexts/TranslationContext';
|
||||
|
||||
function MyComponent() {
|
||||
const title = useMessage('modals.main.title');
|
||||
const description = useMessage('modals.main.description');
|
||||
const t = useT();
|
||||
|
||||
return (
|
||||
<div>
|
||||
<h1>{title}</h1>
|
||||
<p>{description}</p>
|
||||
<h1>{t('modals.main.title')}</h1>
|
||||
<p>{t('modals.main.description')}</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### For existing components
|
||||
**Alternative** - Use the full hook:
|
||||
|
||||
The old `variables.getMessage()` method still works but won't automatically update when language changes. Gradually migrate to `useMessage` for components that display translations prominently.
|
||||
```jsx
|
||||
import { useTranslation } from 'contexts/TranslationContext';
|
||||
|
||||
### How it works
|
||||
function MyComponent() {
|
||||
const { t, language, changeLanguage } = useTranslation();
|
||||
|
||||
1. `TranslationProvider` wraps the app and listens for language change events
|
||||
2. When language is changed via the Radio component, it emits a `languageChange` event
|
||||
3. The provider updates the i18n instance and triggers re-renders
|
||||
4. Components using `useMessage` automatically update to show new translations
|
||||
return (
|
||||
<div>
|
||||
<h1>{t('modals.main.title')}</h1>
|
||||
<button onClick={() => changeLanguage('es')}>Español</button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Backward Compatibility
|
||||
|
||||
The old `variables.getMessage()` method still works and is automatically reactive:
|
||||
|
||||
```jsx
|
||||
// This still works and updates on language change
|
||||
const title = variables.getMessage('modals.main.title');
|
||||
```
|
||||
|
||||
This allows gradual migration of components.
|
||||
|
||||
### How It Works
|
||||
|
||||
1. **TranslationProvider** wraps the app and manages the i18n instance
|
||||
2. **Single source of truth** - All translation logic is centralized in the context
|
||||
3. **Automatic reactivity** - Components using `t()` automatically re-render on language change
|
||||
4. **Backward compatible** - `variables.getMessage()` is updated to use the context internally
|
||||
5. **No EventBus needed** - Direct context updates for language changes
|
||||
|
||||
### Benefits
|
||||
|
||||
- No page refresh needed
|
||||
- Minimal performance impact (translations already loaded)
|
||||
- Backward compatible with existing code
|
||||
- Smooth user experience
|
||||
✅ **Instant updates** - No page refresh needed
|
||||
✅ **Single API** - One consistent way to translate
|
||||
✅ **Automatic re-renders** - React handles updates efficiently
|
||||
✅ **Minimal performance impact** - Translations pre-loaded, only switching active language
|
||||
✅ **Type-safe ready** - Easy to add TypeScript support later
|
||||
✅ **Clean architecture** - Centralized translation logic
|
||||
|
||||
### Migration Guide
|
||||
|
||||
**Before:**
|
||||
```jsx
|
||||
const title = variables.getMessage('modals.main.title');
|
||||
```
|
||||
|
||||
**After:**
|
||||
```jsx
|
||||
const t = useT();
|
||||
const title = t('modals.main.title');
|
||||
```
|
||||
|
||||
### Components Updated
|
||||
|
||||
Core navigation and UI:
|
||||
- ✅ TranslationContext (centralized API)
|
||||
- ✅ Radio component (language selector)
|
||||
- ✅ Tab, Tabs (sidebar navigation)
|
||||
- ✅ ModalTopBar (breadcrumbs)
|
||||
- ✅ Settings view
|
||||
- ✅ Language section
|
||||
- ✅ Refresh button
|
||||
- ✅ Welcome modal
|
||||
|
||||
All other components continue to work via backward compatibility.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { createContext, useContext, useState, useEffect, useCallback } from 'react';
|
||||
import { createContext, useContext, useState, useEffect, useCallback, useMemo, useRef } from 'react';
|
||||
import { initTranslations, translations } from 'lib/translations';
|
||||
import variables from 'config/variables';
|
||||
import EventBus from 'utils/eventbus';
|
||||
@@ -6,25 +6,51 @@ import EventBus from 'utils/eventbus';
|
||||
const TranslationContext = createContext();
|
||||
|
||||
export function TranslationProvider({ children, initialLanguage }) {
|
||||
const [languagecode, setLanguagecode] = useState(initialLanguage);
|
||||
const [currentLanguage, setCurrentLanguage] = useState(initialLanguage);
|
||||
const i18nInstance = useRef(null);
|
||||
|
||||
// Initialize i18n instance once
|
||||
useEffect(() => {
|
||||
i18nInstance.current = initTranslations(currentLanguage);
|
||||
variables.language = i18nInstance.current;
|
||||
variables.languagecode = currentLanguage;
|
||||
document.documentElement.lang = currentLanguage.replace('_', '-');
|
||||
}, [currentLanguage]);
|
||||
|
||||
// Change language function
|
||||
const changeLanguage = useCallback((newLanguage) => {
|
||||
// Update the i18n instance
|
||||
variables.language = initTranslations(newLanguage);
|
||||
i18nInstance.current = initTranslations(newLanguage);
|
||||
variables.language = i18nInstance.current;
|
||||
variables.languagecode = newLanguage;
|
||||
document.documentElement.lang = newLanguage.replace('_', '-');
|
||||
|
||||
// Update tab name if it's still the default
|
||||
if (localStorage.getItem('tabName') === variables.getMessage('tabname')) {
|
||||
const newTabName = translations[newLanguage.replace('-', '_')]?.tabname || variables.getMessage('tabname');
|
||||
const currentTabName = localStorage.getItem('tabName');
|
||||
const oldDefaultTabName = i18nInstance.current?.getMessage(currentLanguage, 'tabname');
|
||||
|
||||
if (currentTabName === oldDefaultTabName || !currentTabName) {
|
||||
const newTabName = translations[newLanguage.replace('-', '_')]?.tabname ||
|
||||
i18nInstance.current?.getMessage(newLanguage, 'tabname') ||
|
||||
'Mue';
|
||||
localStorage.setItem('tabName', newTabName);
|
||||
document.title = newTabName;
|
||||
}
|
||||
|
||||
// Update state to trigger re-render
|
||||
setLanguagecode(newLanguage);
|
||||
}, []);
|
||||
// Update language in localStorage
|
||||
localStorage.setItem('language', newLanguage);
|
||||
|
||||
// Update state to trigger re-render
|
||||
setCurrentLanguage(newLanguage);
|
||||
}, [currentLanguage]);
|
||||
|
||||
// Single translation function - the main API
|
||||
const t = useCallback((key, optional = {}) => {
|
||||
if (!i18nInstance.current) return key;
|
||||
return i18nInstance.current.getMessage(currentLanguage, key, optional);
|
||||
}, [currentLanguage]);
|
||||
|
||||
// Listen for EventBus language change events (for backward compatibility)
|
||||
useEffect(() => {
|
||||
const handleLanguageChange = (data) => {
|
||||
if (data?.language) {
|
||||
@@ -39,8 +65,20 @@ export function TranslationProvider({ children, initialLanguage }) {
|
||||
};
|
||||
}, [changeLanguage]);
|
||||
|
||||
// Update variables.getMessage for backward compatibility
|
||||
useEffect(() => {
|
||||
variables.getMessage = (key, optional = {}) => t(key, optional);
|
||||
}, [t]);
|
||||
|
||||
const value = useMemo(() => ({
|
||||
language: currentLanguage,
|
||||
languagecode: currentLanguage, // Alias for backward compatibility
|
||||
changeLanguage,
|
||||
t,
|
||||
}), [currentLanguage, changeLanguage, t]);
|
||||
|
||||
return (
|
||||
<TranslationContext.Provider value={{ languagecode, changeLanguage }}>
|
||||
<TranslationContext.Provider value={value}>
|
||||
{children}
|
||||
</TranslationContext.Provider>
|
||||
);
|
||||
@@ -54,10 +92,8 @@ export function useTranslation() {
|
||||
return context;
|
||||
}
|
||||
|
||||
// Hook for reactive translations - triggers re-render when language changes
|
||||
export function useMessage(key, optional = {}) {
|
||||
const { languagecode } = useTranslation();
|
||||
// The languagecode dependency ensures this hook re-evaluates when language changes
|
||||
// This is intentional - we use it to trigger re-renders even though it's not directly used
|
||||
return languagecode ? variables.getMessage(key, optional) : '';
|
||||
// Convenience hook - just returns the t function
|
||||
export function useT() {
|
||||
const { t } = useTranslation();
|
||||
return t;
|
||||
}
|
||||
|
||||
@@ -1 +1 @@
|
||||
export { TranslationProvider, useTranslation, useMessage } from './TranslationContext';
|
||||
export { TranslationProvider, useTranslation, useT } from './TranslationContext';
|
||||
|
||||
Reference in New Issue
Block a user