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

[RFR] Refactor I18n layer to use hooks #3672

Merged
merged 10 commits into from
Sep 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1012,3 +1012,120 @@ If you have custom Login or Logout buttons that dispatch these actions, they wil
If you had custom reducer or sagas based on these actions, they will no longer work. You will have to reimplement that custom logic using the new authentication hooks.

**Tip**: If you need to clear the Redux state, you can dispatch the `CLEAR_STATE` action.

## The translation layer no longer uses Redux

React-admin translation (i18n) layer lets developers provide translations for UI and content, based on Airbnb's [Polyglot](https://airbnb.io/polyglot.js/) library. The previous implementation used Redux and redux-saga. In react-admin 3.0, the translation utilities are implemented using a React context and a set of hooks.

If you didn't use translations, or if you passed your `i18nProvider` to the `<Admin>` component and used only one language, you have nothing to change. Your app will continue to work just as before. We encourage you to migrate from the `withTranslate` HOC to the `useTranslate` hook, but that's not compulsory.

```diff
-import { withTranslate } from 'react-admin';
+import { useTranslate } from 'react-admin';

-const SettingsMenu = ({ translate }) => {
+const SettingsMenu = () => {
+ const translate = useTranslate();
return <MenuItem>{translate('settings')}</MenuItem>;
}

-export default withTranslate(SettingsMenu);
+export default SettingsMenu;
```

However, if your app allowed users to change locale at runtime, you need to update the menu or button that triggers the locale change. Instead of dispatching a `CHANGE_LOCALE` Redux action (which has no effect in react-admin 3.0), use the `useSetLocale` hook as follows:

```diff
import React from 'react';
-import { connect } from 'react-redux';
import Button from '@material-ui/core/Button';
-import { changeLocale } from 'react-admin';
+import { useSetLocale } from 'react-admin';

-const localeSwitcher = ({ changeLocale }) =>
+const LocaleSwitcher = () => {
+ const setLocale = usesetLocale();
- const switchToFrench = () => changeLocale('fr');
+ const switchToFrench = () => setLocale('fr');
- const switchToEnglish = () => changeLocale('en');
+ const switchToEnglish = () => setLocale('en');
return (
<div>
<div>Language</div>
<Button onClick={switchToEnglish}>en</Button>
<Button onClick={switchToFrench}>fr</Button>
</div>
);
}

-export default connect(null, { changeLocale })(LocaleSwitcher);
+export default LocaleSwitcher;
```

Also, if you connected a component to the redux store to get the current language, you now need to use the `useLocale()` hook instead.

```diff
-import { connect } from 'react-redux';
+import { useLocale } from 'react-admin';

const availableLanguages = {
en: 'English',
fr: 'Français',
}

-const CurrentLanguage = ({ locale }) => {
+const CurrentLanguage = () => {
+ const locale = useLocale();
return <span>{availableLanguages[locale]}</span>;
}

- const mapStatetoProps = state => state.i18n.locale

-export default connect(mapStateToProps)(CurrentLanguage);
+export default CurrentLanguage;
```

If you used a custom Redux store, you must update the `createAdminStore` call to omit the i18n details:

```diff
const App = () => (
<Provider
store={createAdminStore({
authProvider,
dataProvider,
- i18nProvider,
history,
})}
>
<Admin
authProvider={authProvider}
dataProvider={dataProvider}
history={history}
title="My Admin"
>
```

Also, if you used a custom app without the `Admin` component, update the `<TranslationProvider>` call as the signature has changed:

```diff
const App = () => (
<Provider
store={createAdminStore({
authProvider,
dataProvider,
history,
})}
>
<AuthContext.Provider value={authProvider}>
<DataProviderContext.Provider value={dataProvider}>
- <TranslationProvider />
+ <TranslationProvider
+ locale={locale}
+ i18nProvider={i18nProvider}
+ >
<ThemeProvider>
<Resource name="posts" intent="registration" />
<Resource name="comments" intent="registration" />
<Resource name="users" intent="registration" />
// ...
```
19 changes: 10 additions & 9 deletions docs/CustomApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,16 @@ import {
adminReducer,
adminSaga,
defaultI18nProvider,
i18nReducer,
USER_LOGOUT,
} from 'react-admin';

export default ({
authProvider,
dataProvider,
i18nProvider = defaultI18nProvider,
history,
locale = 'en',
}) => {
const reducer = combineReducers({
admin: adminReducer,
i18n: i18nReducer(locale, i18nProvider(locale)),
router: connectRouter(history),
{ /* add your own reducers here */ },
});
Expand All @@ -50,7 +46,7 @@ export default ({
const saga = function* rootSaga() {
yield all(
[
adminSaga(dataProvider, authProvider, i18nProvider),
adminSaga(dataProvider, authProvider),
// add your own sagas here
].map(fork)
);
Expand Down Expand Up @@ -115,7 +111,6 @@ const App = () => (
store={createAdminStore({
authProvider,
dataProvider,
i18nProvider,
history,
})}
>
Expand Down Expand Up @@ -152,7 +147,7 @@ import { createHashHistory } from 'history';
+import { Switch, Route } from 'react-router-dom';
+import withContext from 'recompose/withContext';
-import { Admin, Resource } from 'react-admin';
+import { TranslationProvider, Resource } from 'react-admin';
+import { AuthContext, DataProviderContext, TranslationProvider, Resource } from 'react-admin';
import restProvider from 'ra-data-simple-rest';
import defaultMessages from 'ra-language-english';
+import { ThemeProvider } from '@material-ui/styles';
Expand Down Expand Up @@ -185,7 +180,6 @@ const App = () => (
store={createAdminStore({
authProvider,
dataProvider,
i18nProvider,
history,
})}
>
Expand All @@ -197,7 +191,12 @@ const App = () => (
- <Resource name="posts" list={PostList} create={PostCreate} edit={PostEdit} show={PostShow} />
- <Resource name="comments" list={CommentList} edit={CommentEdit} create={CommentCreate} />
- <Resource name="users" list={UserList} edit={UserEdit} create={UserCreate} />
+ <TranslationProvider>
+ <AuthContext.Provider value={authProvider}>
+ <DataProviderContext.Provider value={dataProvider}>
+ <TranslationProvider
+ locale={locale}
+ i18nProvider={i18nProvider}
+ >
+ <ThemeProvider>
+ <Resource name="posts" intent="registration" />
+ <Resource name="comments" intent="registration" />
Expand Down Expand Up @@ -226,6 +225,8 @@ const App = () => (
+ </ConnectedRouter>
+ </ThemeProvider>
+ </TranslationProvider>
+ </DataProviderContext.Provider>
+ </AuthContext.Provider>
- </Admin>
</Provider>
);
Expand Down
Loading