@mui/docs 5.15.11 → 5.15.12

package/DocsProvider/DocsProvider.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { Translations } from '../i18n';
+export interface DocsConfig {
+    LANGUAGES: string[];
+    LANGUAGES_SSR: string[];
+    LANGUAGES_IN_PROGRESS: string[];
+    LANGUAGES_IGNORE_PAGES: (pathname: string) => boolean;
+}
+export interface DocsProviderProps {
+    config: DocsConfig;
+    defaultUserLanguage: string;
+    children?: React.ReactNode;
+    translations?: Translations;
+}
+export declare function DocsProvider({ config, defaultUserLanguage, translations, children, }: DocsProviderProps): React.JSX.Element;
+export declare function useDocsConfig(): DocsConfig;

package/DocsProvider/DocsProvider.js

@@ -5,12 +5,14 @@ const DocsConfigContext = /*#__PURE__*/React.createContext(null);
 export function DocsProvider({
   config,
   defaultUserLanguage,
+  translations,
   children
 }) {
   return /*#__PURE__*/_jsx(DocsConfigContext.Provider, {
     value: config,
     children: /*#__PURE__*/_jsx(UserLanguageProvider, {
       defaultUserLanguage: defaultUserLanguage,
+      translations: translations,
       children: children
     })
   });

package/DocsProvider/index.d.ts

@@ -0,0 +1 @@
+export * from './DocsProvider';

package/Link/Link.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { LinkProps as NextLinkProps } from 'next/link';
+import { LinkProps as MuiLinkProps } from '@mui/material/Link';
+interface NextLinkComposedProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'>, Omit<NextLinkProps, 'href' | 'as' | 'passHref' | 'onMouseEnter' | 'onClick' | 'onTouchStart'> {
+    to: NextLinkProps['href'];
+    linkAs?: NextLinkProps['as'];
+}
+export type LinkProps = {
+    activeClassName?: string;
+    as?: NextLinkProps['as'];
+    href: NextLinkProps['href'];
+    linkAs?: NextLinkProps['as'];
+    noLinkStyle?: boolean;
+} & Omit<NextLinkComposedProps, 'to' | 'linkAs' | 'href'> & Omit<MuiLinkProps, 'href'>;
+export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
+export {};

package/Link/index.d.ts

@@ -0,0 +1 @@
+export * from './Link';

package/i18n/i18n.d.ts

@@ -0,0 +1,28 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+export interface UserLanguageProviderProps {
+    children: React.ReactNode;
+    translations?: Translations;
+    defaultUserLanguage: string;
+}
+export declare function UserLanguageProvider(props: UserLanguageProviderProps): React.JSX.Element;
+export declare namespace UserLanguageProvider {
+    var propTypes: {
+        children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
+        defaultUserLanguage: PropTypes.Requireable<string>;
+    };
+}
+export declare function useUserLanguage(): string;
+export declare function useSetUserLanguage(): React.Dispatch<React.SetStateAction<string>>;
+export interface TranslateOptions {
+    ignoreWarning?: boolean;
+}
+export declare function useTranslate(): (key: string, options?: TranslateOptions) => any;
+export type Translations = {
+    [key in string]?: string | Translations;
+};
+export interface RequireContext {
+    (req: string): string;
+    keys: () => string[];
+}
+export declare function mapTranslations(req: RequireContext): Translations;

package/i18n/i18n.js

@@ -1,20 +1,20 @@
 import * as React from 'react';
 import PropTypes from 'prop-types';
+import { deepmerge } from '@mui/utils';
+import defaultTranslations from '../translations';
 import { jsx as _jsx } from "react/jsx-runtime";
-function mapTranslations(req) {
-  const translations = {};
-  req.keys().forEach(filename => {
-    const match = filename.match(/-([a-z]{2}).json$/);
-    if (match) {
-      translations[match[1]] = req(filename);
-    } else {
-      translations.en = req(filename);
-    }
+const TranslationsContext = /*#__PURE__*/React.createContext(defaultTranslations);
+function TranslationsProvider({
+  translations = {},
+  children
+}) {
+  const currentTranslations = React.useContext(TranslationsContext);
+  const mergedTranslations = React.useMemo(() => deepmerge(currentTranslations, translations), [currentTranslations, translations]);
+  return /*#__PURE__*/_jsx(TranslationsContext.Provider, {
+    value: mergedTranslations,
+    children: children
   });
-  return translations;
 }
-const req = require.context('docs/translations', false, /translations.*\.json$/);
-const translations = mapTranslations(req);
 function getPath(obj, path) {
   if (!path || typeof path !== 'string') {
     return null;
@@ -31,6 +31,7 @@ if (process.env.NODE_ENV !== 'production') {
 export function UserLanguageProvider(props) {
   const {
     children,
+    translations,
     defaultUserLanguage
   } = props;
   const [userLanguage, setUserLanguage] = React.useState(defaultUserLanguage);
@@ -40,9 +41,12 @@ export function UserLanguageProvider(props) {
       setUserLanguage
     };
   }, [userLanguage]);
-  return /*#__PURE__*/_jsx(UserLanguageContext.Provider, {
-    value: contextValue,
-    children: children
+  return /*#__PURE__*/_jsx(TranslationsProvider, {
+    translations: translations,
+    children: /*#__PURE__*/_jsx(UserLanguageContext.Provider, {
+      value: contextValue,
+      children: children
+    })
   });
 }
 process.env.NODE_ENV !== "production" ? UserLanguageProvider.propTypes = {
@@ -58,6 +62,7 @@ export function useSetUserLanguage() {
 const warnedOnce = {};
 export function useTranslate() {
   const userLanguage = useUserLanguage();
+  const translations = React.useContext(TranslationsContext);
   return React.useMemo(() => function translate(key, options = {}) {
     const {
       ignoreWarning = false
@@ -78,5 +83,17 @@ export function useTranslate() {
       return getPath(translations.en, key);
     }
     return translation;
-  }, [userLanguage]);
+  }, [userLanguage, translations]);
+}
+export function mapTranslations(req) {
+  const result = {};
+  req.keys().forEach(filename => {
+    const match = filename.match(/-([a-z]{2}).json$/);
+    if (match) {
+      result[match[1]] = req(filename);
+    } else {
+      result.en = req(filename);
+    }
+  });
+  return result;
 }

package/i18n/index.d.ts

@@ -0,0 +1 @@
+export * from './i18n';

package/i18n/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/i18n/index.js",
+  "types": "./index.d.ts"
+}

package/legacy/DocsProvider/DocsProvider.js

@@ -5,11 +5,13 @@ var DocsConfigContext = /*#__PURE__*/React.createContext(null);
 export function DocsProvider(_ref) {
   var config = _ref.config,
     defaultUserLanguage = _ref.defaultUserLanguage,
+    translations = _ref.translations,
     children = _ref.children;
   return /*#__PURE__*/_jsx(DocsConfigContext.Provider, {
     value: config,
     children: /*#__PURE__*/_jsx(UserLanguageProvider, {
       defaultUserLanguage: defaultUserLanguage,
+      translations: translations,
       children: children
     })
   });

package/legacy/i18n/i18n.js

@@ -1,20 +1,22 @@
 import * as React from 'react';
 import PropTypes from 'prop-types';
+import { deepmerge } from '@mui/utils';
+import defaultTranslations from '../translations';
 import { jsx as _jsx } from "react/jsx-runtime";
-function mapTranslations(req) {
-  var translations = {};
-  req.keys().forEach(function (filename) {
-    var match = filename.match(/-([a-z]{2}).json$/);
-    if (match) {
-      translations[match[1]] = req(filename);
-    } else {
-      translations.en = req(filename);
-    }
+var TranslationsContext = /*#__PURE__*/React.createContext(defaultTranslations);
+function TranslationsProvider(_ref) {
+  var _ref$translations = _ref.translations,
+    translations = _ref$translations === void 0 ? {} : _ref$translations,
+    children = _ref.children;
+  var currentTranslations = React.useContext(TranslationsContext);
+  var mergedTranslations = React.useMemo(function () {
+    return deepmerge(currentTranslations, translations);
+  }, [currentTranslations, translations]);
+  return /*#__PURE__*/_jsx(TranslationsContext.Provider, {
+    value: mergedTranslations,
+    children: children
   });
-  return translations;
 }
-var req = require.context('docs/translations', false, /translations.*\.json$/);
-var translations = mapTranslations(req);
 function getPath(obj, path) {
   if (!path || typeof path !== 'string') {
     return null;
@@ -32,6 +34,7 @@ if (process.env.NODE_ENV !== 'production') {
 }
 export function UserLanguageProvider(props) {
   var children = props.children,
+    translations = props.translations,
     defaultUserLanguage = props.defaultUserLanguage;
   var _React$useState = React.useState(defaultUserLanguage),
     userLanguage = _React$useState[0],
@@ -42,9 +45,12 @@ export function UserLanguageProvider(props) {
       setUserLanguage: setUserLanguage
     };
   }, [userLanguage]);
-  return /*#__PURE__*/_jsx(UserLanguageContext.Provider, {
-    value: contextValue,
-    children: children
+  return /*#__PURE__*/_jsx(TranslationsProvider, {
+    translations: translations,
+    children: /*#__PURE__*/_jsx(UserLanguageContext.Provider, {
+      value: contextValue,
+      children: children
+    })
   });
 }
 process.env.NODE_ENV !== "production" ? UserLanguageProvider.propTypes = {
@@ -60,6 +66,7 @@ export function useSetUserLanguage() {
 var warnedOnce = {};
 export function useTranslate() {
   var userLanguage = useUserLanguage();
+  var translations = React.useContext(TranslationsContext);
   return React.useMemo(function () {
     return function translate(key) {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -82,5 +89,17 @@ export function useTranslate() {
       }
       return translation;
     };
-  }, [userLanguage]);
+  }, [userLanguage, translations]);
+}
+export function mapTranslations(req) {
+  var result = {};
+  req.keys().forEach(function (filename) {
+    var match = filename.match(/-([a-z]{2}).json$/);
+    if (match) {
+      result[match[1]] = req(filename);
+    } else {
+      result.en = req(filename);
+    }
+  });
+  return result;
 }

package/legacy/translations/index.js

@@ -0,0 +1,4 @@
+import en from './translations.json';
+export default {
+  en: en
+};

package/node/DocsProvider/DocsProvider.js

@@ -14,12 +14,14 @@ const DocsConfigContext = /*#__PURE__*/React.createContext(null);
 function DocsProvider({
   config,
   defaultUserLanguage,
+  translations,
   children
 }) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(DocsConfigContext.Provider, {
     value: config,
     children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_i18n.UserLanguageProvider, {
       defaultUserLanguage: defaultUserLanguage,
+      translations: translations,
       children: children
     })
   });

package/node/i18n/i18n.js

@@ -5,28 +5,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.UserLanguageProvider = UserLanguageProvider;
+exports.mapTranslations = mapTranslations;
 exports.useSetUserLanguage = useSetUserLanguage;
 exports.useTranslate = useTranslate;
 exports.useUserLanguage = useUserLanguage;
 var React = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
+var _utils = require("@mui/utils");
+var _translations = _interopRequireDefault(require("../translations"));
 var _jsxRuntime = require("react/jsx-runtime");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-function mapTranslations(req) {
-  const translations = {};
-  req.keys().forEach(filename => {
-    const match = filename.match(/-([a-z]{2}).json$/);
-    if (match) {
-      translations[match[1]] = req(filename);
-    } else {
-      translations.en = req(filename);
-    }
+const TranslationsContext = /*#__PURE__*/React.createContext(_translations.default);
+function TranslationsProvider({
+  translations = {},
+  children
+}) {
+  const currentTranslations = React.useContext(TranslationsContext);
+  const mergedTranslations = React.useMemo(() => (0, _utils.deepmerge)(currentTranslations, translations), [currentTranslations, translations]);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(TranslationsContext.Provider, {
+    value: mergedTranslations,
+    children: children
   });
-  return translations;
 }
-const req = require.context('docs/translations', false, /translations.*\.json$/);
-const translations = mapTranslations(req);
 function getPath(obj, path) {
   if (!path || typeof path !== 'string') {
     return null;
@@ -43,6 +44,7 @@ if (process.env.NODE_ENV !== 'production') {
 function UserLanguageProvider(props) {
   const {
     children,
+    translations,
     defaultUserLanguage
   } = props;
   const [userLanguage, setUserLanguage] = React.useState(defaultUserLanguage);
@@ -52,9 +54,12 @@ function UserLanguageProvider(props) {
       setUserLanguage
     };
   }, [userLanguage]);
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(UserLanguageContext.Provider, {
-    value: contextValue,
-    children: children
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(TranslationsProvider, {
+    translations: translations,
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(UserLanguageContext.Provider, {
+      value: contextValue,
+      children: children
+    })
   });
 }
 process.env.NODE_ENV !== "production" ? UserLanguageProvider.propTypes = {
@@ -70,6 +75,7 @@ function useSetUserLanguage() {
 const warnedOnce = {};
 function useTranslate() {
   const userLanguage = useUserLanguage();
+  const translations = React.useContext(TranslationsContext);
   return React.useMemo(() => function translate(key, options = {}) {
     const {
       ignoreWarning = false
@@ -90,5 +96,17 @@ function useTranslate() {
       return getPath(translations.en, key);
     }
     return translation;
-  }, [userLanguage]);
+  }, [userLanguage, translations]);
+}
+function mapTranslations(req) {
+  const result = {};
+  req.keys().forEach(filename => {
+    const match = filename.match(/-([a-z]{2}).json$/);
+    if (match) {
+      result[match[1]] = req(filename);
+    } else {
+      result.en = req(filename);
+    }
+  });
+  return result;
 }

package/node/translations/index.js

@@ -0,0 +1,11 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _translations = _interopRequireDefault(require("./translations.json"));
+var _default = exports.default = {
+  en: _translations.default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/docs",
-  "version": "5.15.11",
+  "version": "5.15.12",
   "private": false,
   "author": "MUI Team",
   "description": "MUI Docs - Documentation building blocks.",
@@ -27,14 +27,14 @@
     "clsx": "^2.1.0",
     "nprogress": "^0.2.0",
     "prop-types": "^15.8.1",
-    "@mui/base": "5.0.0-beta.37",
-    "@mui/utils": "^5.15.11"
+    "@mui/base": "5.0.0-beta.38",
+    "@mui/utils": "^5.15.12"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0",
     "next": "^13.5.1",
     "react": "^17.0.0 || ^18.0.0",
-    "@mui/material": "^5.15.11"
+    "@mui/material": "^5.15.12"
   },
   "peerDependenciesMeta": {
     "@types/react": {
@@ -48,6 +48,5 @@
   "engines": {
     "node": ">=12.0.0"
   },
-  "module": "./index.js",
-  "types": "./index.d.ts"
+  "module": "./index.js"
 }

package/translations/index.d.ts

@@ -0,0 +1,3 @@
+import type { Translations } from '../i18n';
+declare const _default: Record<string, Translations>;
+export default _default;

package/translations/index.js

@@ -0,0 +1,4 @@
+import en from './translations.json';
+export default {
+  en
+};

package/translations/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/translations/index.js",
+  "types": "./index.d.ts"
+}