Support resource specific translations in EditButton

Author: djhi

packages/ra-ui-materialui/src/button/EditButton.spec.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { fireEvent, render, screen, waitFor } from '@testing-library/react';
 import expect from 'expect';
-import { Basic, AccessControl } from './EditButton.stories';
+import { Basic, AccessControl, Label } from './EditButton.stories';
 
 const invalidButtonDomProps = {
     redirect: 'list',
@@ -23,6 +23,22 @@ describe('<EditButton />', () => {
         spy.mockRestore();
     });
 
+    it('should provide a default label', async () => {
+        render(<Label translations="default" />);
+        await screen.findByText('Edit');
+        fireEvent.click(screen.getByText('English', { selector: 'button' }));
+        fireEvent.click(await screen.findByText('Français'));
+        await screen.findByText('Éditer');
+    });
+
+    it('should allow resource specific default title', async () => {
+        render(<Label translations="resource specific" />);
+        await screen.findByText('Change War and Peace');
+        fireEvent.click(screen.getByText('English', { selector: 'button' }));
+        fireEvent.click(await screen.findByText('Français'));
+        await screen.findByText('Modifier War and Peace');
+    });
+
     it('should only render when users have the right to edit', async () => {
         render(<AccessControl />);
         await screen.findByText('War and Peace');

packages/ra-ui-materialui/src/button/EditButton.stories.tsx

@@ -4,6 +4,9 @@ import englishMessages from 'ra-language-english';
 import frenchMessages from 'ra-language-french';
 import {
     AuthProvider,
+    I18nProvider,
+    memoryStore,
+    mergeTranslations,
     RecordContextProvider,
     Resource,
     ResourceContextProvider,
@@ -20,15 +23,53 @@ import { SimpleForm } from '../form/SimpleForm';
 import { TextInput } from '../input/TextInput';
 import { EditButton } from './EditButton';
 import { Edit } from '../detail/Edit';
+import { LocalesMenuButton } from './LocalesMenuButton';
 
 export default { title: 'ra-ui-materialui/button/EditButton' };
 
+const defaultI18nProvider = () =>
+    polyglotI18nProvider(
+        locale => (locale === 'fr' ? frenchMessages : englishMessages),
+        'en',
+        [
+            { locale: 'en', name: 'English' },
+            { locale: 'fr', name: 'Français' },
+        ]
+    );
+
+const customI18nProvider = polyglotI18nProvider(
+    locale =>
+        locale === 'fr'
+            ? mergeTranslations(frenchMessages, {
+                  resources: {
+                      books: {
+                          action: {
+                              edit: 'Modifier %{recordRepresentation}',
+                          },
+                      },
+                  },
+              })
+            : mergeTranslations(englishMessages, {
+                  resources: {
+                      books: {
+                          action: {
+                              edit: 'Change %{recordRepresentation}',
+                          },
+                      },
+                  },
+              }),
+    'en',
+    [
+        { locale: 'en', name: 'English' },
+        { locale: 'fr', name: 'Français' },
+    ]
+);
+
 export const Basic = ({ buttonProps }: { buttonProps?: any }) => (
     <TestMemoryRouter>
         <AdminContext
-            i18nProvider={polyglotI18nProvider(locale =>
-                locale === 'fr' ? frenchMessages : englishMessages
-            )}
+            i18nProvider={defaultI18nProvider()}
+            store={memoryStore()}
         >
             <ResourceContextProvider value="books">
                 <RecordContextProvider value={{ id: 1 }}>
@@ -39,6 +80,47 @@ export const Basic = ({ buttonProps }: { buttonProps?: any }) => (
     </TestMemoryRouter>
 );
 
+export const Label = ({
+    translations = 'default',
+    i18nProvider = translations === 'default'
+        ? defaultI18nProvider()
+        : customI18nProvider,
+    label,
+}: {
+    i18nProvider?: I18nProvider;
+    translations?: 'default' | 'resource specific';
+    label?: string;
+}) => (
+    <TestMemoryRouter>
+        <AdminContext
+            dataProvider={dataProvider}
+            i18nProvider={i18nProvider}
+            store={memoryStore()}
+        >
+            <ResourceContextProvider value="books">
+                <RecordContextProvider
+                    value={{ id: 1, title: 'War and Peace' }}
+                >
+                    <div>
+                        <EditButton label={label} />
+                    </div>
+                </RecordContextProvider>
+                <LocalesMenuButton />
+            </ResourceContextProvider>
+        </AdminContext>
+    </TestMemoryRouter>
+);
+
+Label.args = {
+    translations: 'default',
+};
+Label.argTypes = {
+    translations: {
+        options: ['default', 'resource specific'],
+        control: { type: 'radio' },
+    },
+};
+
 export const AccessControl = () => {
     const queryClient = new QueryClient();
 
@@ -79,10 +161,9 @@ const AccessControlAdmin = ({ queryClient }: { queryClient: QueryClient }) => {
         <AdminContext
             dataProvider={dataProvider}
             authProvider={authProvider}
-            i18nProvider={polyglotI18nProvider(locale =>
-                locale === 'fr' ? frenchMessages : englishMessages
-            )}
+            i18nProvider={defaultI18nProvider()}
             queryClient={queryClient}
+            store={memoryStore()}
         >
             <AdminUI
                 layout={({ children }) => (

packages/ra-ui-materialui/src/button/EditButton.tsx

@@ -14,6 +14,9 @@ import {
     useRecordContext,
     useCreatePath,
     useCanAccess,
+    useTranslate,
+    useGetResourceLabel,
+    useGetRecordRepresentation,
 } from 'ra-core';
 
 import { Button, ButtonProps } from './Button';
@@ -39,7 +42,7 @@ export const EditButton = <RecordType extends RaRecord = any>(
     });
     const {
         icon = defaultIcon,
-        label = 'ra.action.edit',
+        label: labelProp,
         scrollToTop = true,
         className,
         ...rest
@@ -57,7 +60,27 @@ export const EditButton = <RecordType extends RaRecord = any>(
         resource,
         record,
     });
+    const translate = useTranslate();
+    const getResourceLabel = useGetResourceLabel();
+    const getRecordRepresentation = useGetRecordRepresentation();
+    const recordRepresentationValue = getRecordRepresentation(record);
+
     if (!record || !canAccess || isPending) return null;
+
+    const recordRepresentation =
+        typeof recordRepresentationValue === 'string'
+            ? recordRepresentationValue
+            : recordRepresentationValue?.toString();
+    const label =
+        labelProp ??
+        translate(`resources.${resource}.action.edit`, {
+            recordRepresentation,
+            _: translate(`ra.action.edit`, {
+                name: getResourceLabel(resource, 1),
+                recordRepresentation,
+            }),
+        });
+
     return (
         <StyledButton
             component={Link}