fix: Jan review 1

mui · Feb 6, 2025 · a2d8d67 · a2d8d67
1 parent a7fd3a5
commit a2d8d67
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 108 deletions.
diff --git a/docs/data/toolpad/core/introduction/base-concepts.md b/docs/data/toolpad/core/introduction/base-concepts.md
@@ -120,6 +120,7 @@ To translate all your Toolpad components, you can provide translations through t
 
 ```tsx
 import { createTheme, ThemeProvider } from '@mui/material/styles';
+import { hiIN as coreHiIn } from '@mui/material/locale';
 import hiIN from '@toolpad/core/locales/hiIN';
 
 const theme = createTheme({
@@ -128,6 +129,7 @@ const theme = createTheme({
       primary: { main: '#1976d2' },
     },
   },
+  coreHiIn,
   hiIN,
 });
 

diff --git a/docs/pages/toolpad/core/api/account.json b/docs/pages/toolpad/core/api/account.json
@@ -1,11 +1,6 @@
 {
   "props": {
-    "localeText": {
-      "type": {
-        "name": "shape",
-        "description": "{ accountPreviewIconButtonLabel?: string, accountPreviewTitle?: string, accountSignInLabel?: string, accountSignOutLabel?: string }"
-      }
-    },
+    "localeText": { "type": { "name": "object" } },
     "slotProps": {
       "type": {
         "name": "shape",

diff --git a/docs/pages/toolpad/core/api/app-provider.json b/docs/pages/toolpad/core/api/app-provider.json
@@ -12,12 +12,7 @@
       },
       "default": "null"
     },
-    "localeText": {
-      "type": {
-        "name": "shape",
-        "description": "{ accountPreviewIconButtonLabel?: string, accountPreviewTitle?: string, accountSignInLabel?: string, accountSignOutLabel?: string, alert?: string, cancel?: string, close?: string, confirm?: string, delete?: string, email?: string, loading?: string, magicLinkSignInTitle?: string, oauthSignInTitle?: string, ok?: string, or?: string, passkey?: string, passkeySignInTitle?: string, password?: string, save?: string, signInRememberMe?: string, signInSubtitle?: string, signInTitle?: string, to?: string, username?: string, with?: string }"
-      }
-    },
+    "localeText": { "type": { "name": "object" } },
     "navigation": {
       "type": {
         "name": "arrayOf",

diff --git a/docs/pages/toolpad/core/api/dashboard-layout.json b/docs/pages/toolpad/core/api/dashboard-layout.json
@@ -25,7 +25,7 @@
     "slotProps": {
       "type": {
         "name": "shape",
-        "description": "{ appTitle?: { branding?: { homeUrl?: string, logo?: node, title?: string } }, sidebarFooter?: { mini: bool }, toolbarAccount?: { localeText?: { accountPreviewIconButtonLabel?: string, accountPreviewTitle?: string, accountSignInLabel?: string, accountSignOutLabel?: string }, slotProps?: { popover?: object, popoverContent?: object, preview?: object, signInButton?: object, signOutButton?: object }, slots?: { popover?: elementType, popoverContent?: elementType, preview?: elementType, signInButton?: elementType, signOutButton?: elementType } }, toolbarActions?: object }"
+        "description": "{ appTitle?: { branding?: { homeUrl?: string, logo?: node, title?: string } }, sidebarFooter?: { mini: bool }, toolbarAccount?: { localeText?: object, slotProps?: { popover?: object, popoverContent?: object, preview?: object, signInButton?: object, signOutButton?: object }, slots?: { popover?: elementType, popoverContent?: elementType, preview?: elementType, signInButton?: elementType, signOutButton?: elementType } }, toolbarActions?: object }"
       },
       "default": "{}"
     },

diff --git a/docs/pages/toolpad/core/api/localization-provider.json b/docs/pages/toolpad/core/api/localization-provider.json
@@ -1,12 +1,5 @@
 {
-  "props": {
-    "localeText": {
-      "type": {
-        "name": "shape",
-        "description": "{ accountPreviewIconButtonLabel?: string, accountPreviewTitle?: string, accountSignInLabel?: string, accountSignOutLabel?: string, alert?: string, cancel?: string, close?: string, confirm?: string, delete?: string, email?: string, loading?: string, magicLinkSignInTitle?: string, oauthSignInTitle?: string, ok?: string, or?: string, passkey?: string, passkeySignInTitle?: string, password?: string, save?: string, signInRememberMe?: string, signInSubtitle?: string, signInTitle?: string, to?: string, username?: string, with?: string }"
-      }
-    }
-  },
+  "props": { "localeText": { "type": { "name": "object" } } },
   "name": "LocalizationProvider",
   "imports": ["import { LocalizationProvider } from '@toolpad/core/AppProvider';"],
   "classes": [],

diff --git a/docs/pages/toolpad/core/api/sign-in-page.json b/docs/pages/toolpad/core/api/sign-in-page.json
@@ -1,11 +1,6 @@
 {
   "props": {
-    "localeText": {
-      "type": {
-        "name": "shape",
-        "description": "{ email?: string, or?: string, passkey?: string, password?: string, signInRememberMe?: string, signInSubtitle?: string, signInTitle?: string, to?: string, with?: string }"
-      }
-    },
+    "localeText": { "type": { "name": "object" } },
     "providers": {
       "type": { "name": "arrayOf", "description": "Array&lt;{ id: string, name: string }&gt;" },
       "default": "[]"

diff --git a/packages/toolpad-core/src/Account/Account.tsx b/packages/toolpad-core/src/Account/Account.tsx
@@ -211,12 +211,7 @@ Account.propTypes /* remove-proptypes */ = {
   /**
    * The labels for the account component.
    */
-  localeText: PropTypes.shape({
-    accountPreviewIconButtonLabel: PropTypes.string,
-    accountPreviewTitle: PropTypes.string,
-    accountSignInLabel: PropTypes.string,
-    accountSignOutLabel: PropTypes.string,
-  }),
+  localeText: PropTypes.object,
   /**
    * The props used for each slot inside.
    */

diff --git a/packages/toolpad-core/src/AppProvider/AppProvider.tsx b/packages/toolpad-core/src/AppProvider/AppProvider.tsx
@@ -213,33 +213,7 @@ AppProvider.propTypes /* remove-proptypes */ = {
   /**
    * Locale text for components
    */
-  localeText: PropTypes.shape({
-    accountPreviewIconButtonLabel: PropTypes.string,
-    accountPreviewTitle: PropTypes.string,
-    accountSignInLabel: PropTypes.string,
-    accountSignOutLabel: PropTypes.string,
-    alert: PropTypes.string,
-    cancel: PropTypes.string,
-    close: PropTypes.string,
-    confirm: PropTypes.string,
-    delete: PropTypes.string,
-    email: PropTypes.string,
-    loading: PropTypes.string,
-    magicLinkSignInTitle: PropTypes.string,
-    oauthSignInTitle: PropTypes.string,
-    ok: PropTypes.string,
-    or: PropTypes.string,
-    passkey: PropTypes.string,
-    passkeySignInTitle: PropTypes.string,
-    password: PropTypes.string,
-    save: PropTypes.string,
-    signInRememberMe: PropTypes.string,
-    signInSubtitle: PropTypes.string,
-    signInTitle: PropTypes.string,
-    to: PropTypes.string,
-    username: PropTypes.string,
-    with: PropTypes.string,
-  }),
+  localeText: PropTypes.object,
   /**
    * Navigation definition for the app.
    * @default []

diff --git a/packages/toolpad-core/src/AppProvider/LocalizationProvider.tsx b/packages/toolpad-core/src/AppProvider/LocalizationProvider.tsx
@@ -87,33 +87,7 @@ LocalizationProvider.propTypes /* remove-proptypes */ = {
   /**
    * Locale for components texts
    */
-  localeText: PropTypes.shape({
-    accountPreviewIconButtonLabel: PropTypes.string,
-    accountPreviewTitle: PropTypes.string,
-    accountSignInLabel: PropTypes.string,
-    accountSignOutLabel: PropTypes.string,
-    alert: PropTypes.string,
-    cancel: PropTypes.string,
-    close: PropTypes.string,
-    confirm: PropTypes.string,
-    delete: PropTypes.string,
-    email: PropTypes.string,
-    loading: PropTypes.string,
-    magicLinkSignInTitle: PropTypes.string,
-    oauthSignInTitle: PropTypes.string,
-    ok: PropTypes.string,
-    or: PropTypes.string,
-    passkey: PropTypes.string,
-    passkeySignInTitle: PropTypes.string,
-    password: PropTypes.string,
-    save: PropTypes.string,
-    signInRememberMe: PropTypes.string,
-    signInSubtitle: PropTypes.string,
-    signInTitle: PropTypes.string,
-    to: PropTypes.string,
-    username: PropTypes.string,
-    with: PropTypes.string,
-  }),
+  localeText: PropTypes.object,
 } as any;
 
 export { LocalizationProvider };

diff --git a/packages/toolpad-core/src/DashboardLayout/DashboardLayout.tsx b/packages/toolpad-core/src/DashboardLayout/DashboardLayout.tsx
@@ -545,12 +545,7 @@ DashboardLayout.propTypes /* remove-proptypes */ = {
       mini: PropTypes.bool.isRequired,
     }),
     toolbarAccount: PropTypes.shape({
-      localeText: PropTypes.shape({
-        accountPreviewIconButtonLabel: PropTypes.string,
-        accountPreviewTitle: PropTypes.string,
-        accountSignInLabel: PropTypes.string,
-        accountSignOutLabel: PropTypes.string,
-      }),
+      localeText: PropTypes.object,
       slotProps: PropTypes.shape({
         popover: PropTypes.object,
         popoverContent: PropTypes.object,

diff --git a/packages/toolpad-core/src/SignInPage/SignInPage.tsx b/packages/toolpad-core/src/SignInPage/SignInPage.tsx
@@ -731,17 +731,7 @@ SignInPage.propTypes /* remove-proptypes */ = {
   /**
    * The labels for the account component.
    */
-  localeText: PropTypes.shape({
-    email: PropTypes.string,
-    or: PropTypes.string,
-    passkey: PropTypes.string,
-    password: PropTypes.string,
-    signInRememberMe: PropTypes.string,
-    signInSubtitle: PropTypes.string,
-    signInTitle: PropTypes.string,
-    to: PropTypes.string,
-    with: PropTypes.string,
-  }),
+  localeText: PropTypes.object,
   /**
    * The list of authentication providers to display.
    * @default []

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/generateProptypes.ts b/scripts/generateProptypes.ts
@@ -55,6 +55,10 @@ async function generateProptypes(
     filePath: tsFile,
     project,
     shouldResolveObject: ({ name }) => {
+      const propsToNotResolve = ['localeText'];
+      if (propsToNotResolve.includes(name)) {
+        return false;
+      }
       if (
         name.toLowerCase().endsWith('classes') ||
         name === 'theme' ||