@mui/docs 5.15.9 → 5.15.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +375 -133
- package/DocsProvider/DocsProvider.d.ts +16 -0
- package/DocsProvider/DocsProvider.js +26 -0
- package/DocsProvider/index.d.ts +1 -0
- package/DocsProvider/index.js +1 -0
- package/DocsProvider/package.json +6 -0
- package/Link/Link.d.ts +16 -0
- package/Link/Link.js +106 -0
- package/Link/index.d.ts +1 -0
- package/Link/index.js +1 -0
- package/Link/package.json +6 -0
- package/i18n/i18n.d.ts +28 -0
- package/i18n/i18n.js +99 -0
- package/i18n/index.d.ts +1 -0
- package/i18n/index.js +1 -0
- package/i18n/package.json +6 -0
- package/legacy/DocsProvider/DocsProvider.js +25 -0
- package/legacy/DocsProvider/index.js +1 -0
- package/legacy/Link/Link.js +101 -0
- package/legacy/Link/index.js +1 -0
- package/legacy/i18n/i18n.js +105 -0
- package/legacy/i18n/index.js +1 -0
- package/legacy/translations/index.js +4 -0
- package/node/DocsProvider/DocsProvider.js +35 -0
- package/node/DocsProvider/index.js +16 -0
- package/node/Link/Link.js +113 -0
- package/node/Link/index.js +16 -0
- package/node/i18n/i18n.js +112 -0
- package/node/i18n/index.js +16 -0
- package/node/translations/index.js +11 -0
- package/package.json +8 -7
- package/translations/index.d.ts +3 -0
- package/translations/index.js +4 -0
- package/translations/package.json +6 -0
- package/tsconfig.build.tsbuildinfo +1 -0
- package/index.d.ts +0 -0
- package/index.js +0 -11
- package/legacy/index.js +0 -11
- package/node/index.js +0 -41
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
Object.defineProperty(exports, "__esModule", {
|
|
5
|
+
value: true
|
|
6
|
+
});
|
|
7
|
+
exports.Link = void 0;
|
|
8
|
+
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
|
|
9
|
+
var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
|
|
10
|
+
var React = _interopRequireWildcard(require("react"));
|
|
11
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
12
|
+
var _router = require("next/router");
|
|
13
|
+
var _link = _interopRequireDefault(require("next/link"));
|
|
14
|
+
var _Link = _interopRequireDefault(require("@mui/material/Link"));
|
|
15
|
+
var _styles = require("@mui/material/styles");
|
|
16
|
+
var _i18n = require("../i18n");
|
|
17
|
+
var _DocsProvider = require("../DocsProvider");
|
|
18
|
+
var _jsxRuntime = require("react/jsx-runtime");
|
|
19
|
+
const _excluded = ["to", "linkAs", "replace", "scroll", "shallow", "prefetch", "legacyBehavior", "locale"],
|
|
20
|
+
_excluded2 = ["activeClassName", "as", "className", "href", "legacyBehavior", "linkAs", "locale", "noLinkStyle", "prefetch", "replace", "role", "scroll", "shallow"];
|
|
21
|
+
/**
|
|
22
|
+
* File to keep in sync with:
|
|
23
|
+
*
|
|
24
|
+
* - /docs/src/modules/components/Link.tsx
|
|
25
|
+
* - /examples/material-ui-nextjs-pages-router/src/Link.js
|
|
26
|
+
* - /examples/material-ui-nextjs-pages-router-ts/src/Link.tsx
|
|
27
|
+
*/
|
|
28
|
+
// Add support for the sx prop for consistency with the other branches.
|
|
29
|
+
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); }
|
|
30
|
+
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; }
|
|
31
|
+
const Anchor = (0, _styles.styled)('a')({});
|
|
32
|
+
const NextLinkComposed = /*#__PURE__*/React.forwardRef(function NextLinkComposed(props, ref) {
|
|
33
|
+
const {
|
|
34
|
+
to,
|
|
35
|
+
linkAs,
|
|
36
|
+
replace,
|
|
37
|
+
scroll,
|
|
38
|
+
shallow,
|
|
39
|
+
prefetch,
|
|
40
|
+
legacyBehavior = true,
|
|
41
|
+
locale
|
|
42
|
+
} = props,
|
|
43
|
+
other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded);
|
|
44
|
+
return /*#__PURE__*/(0, _jsxRuntime.jsx)(_link.default, {
|
|
45
|
+
href: to,
|
|
46
|
+
prefetch: prefetch,
|
|
47
|
+
as: linkAs,
|
|
48
|
+
replace: replace,
|
|
49
|
+
scroll: scroll,
|
|
50
|
+
shallow: shallow,
|
|
51
|
+
passHref: true,
|
|
52
|
+
locale: locale,
|
|
53
|
+
legacyBehavior: legacyBehavior,
|
|
54
|
+
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(Anchor, (0, _extends2.default)({
|
|
55
|
+
"data-no-markdown-link": "true",
|
|
56
|
+
ref: ref
|
|
57
|
+
}, other))
|
|
58
|
+
});
|
|
59
|
+
});
|
|
60
|
+
// A styled version of the Next.js Pages Router Link component:
|
|
61
|
+
// https://nextjs.org/docs/pages/api-reference/components/link
|
|
62
|
+
const Link = exports.Link = /*#__PURE__*/React.forwardRef(function Link(props, ref) {
|
|
63
|
+
const {
|
|
64
|
+
activeClassName = 'active',
|
|
65
|
+
as,
|
|
66
|
+
className: classNameProps,
|
|
67
|
+
href,
|
|
68
|
+
legacyBehavior,
|
|
69
|
+
linkAs: linkAsProp,
|
|
70
|
+
locale,
|
|
71
|
+
noLinkStyle,
|
|
72
|
+
prefetch,
|
|
73
|
+
replace,
|
|
74
|
+
// Link don't have roles.
|
|
75
|
+
scroll,
|
|
76
|
+
shallow
|
|
77
|
+
} = props,
|
|
78
|
+
other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded2);
|
|
79
|
+
const router = (0, _router.useRouter)();
|
|
80
|
+
const pathname = typeof href === 'string' ? href : href == null ? void 0 : href.pathname;
|
|
81
|
+
const routerPathname = router.pathname.replace('/[docsTab]', '');
|
|
82
|
+
const shouldBeActive = routerPathname === pathname;
|
|
83
|
+
const className = (0, _clsx.default)(classNameProps, shouldBeActive && activeClassName);
|
|
84
|
+
const userLanguage = (0, _i18n.useUserLanguage)();
|
|
85
|
+
const {
|
|
86
|
+
LANGUAGES_IGNORE_PAGES
|
|
87
|
+
} = (0, _DocsProvider.useDocsConfig)();
|
|
88
|
+
let linkAs = linkAsProp || as || href;
|
|
89
|
+
if (userLanguage !== 'en' && pathname && pathname.indexOf('/') === 0 && !LANGUAGES_IGNORE_PAGES(pathname) && !pathname.startsWith(`/${userLanguage}/`)) {
|
|
90
|
+
linkAs = `/${userLanguage}${linkAs}`;
|
|
91
|
+
}
|
|
92
|
+
const nextjsProps = {
|
|
93
|
+
to: href,
|
|
94
|
+
linkAs,
|
|
95
|
+
replace,
|
|
96
|
+
scroll,
|
|
97
|
+
shallow,
|
|
98
|
+
legacyBehavior,
|
|
99
|
+
prefetch,
|
|
100
|
+
locale
|
|
101
|
+
};
|
|
102
|
+
if (noLinkStyle) {
|
|
103
|
+
return /*#__PURE__*/(0, _jsxRuntime.jsx)(NextLinkComposed, (0, _extends2.default)({
|
|
104
|
+
className: className,
|
|
105
|
+
ref: ref
|
|
106
|
+
}, nextjsProps, other));
|
|
107
|
+
}
|
|
108
|
+
return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Link.default, (0, _extends2.default)({
|
|
109
|
+
component: NextLinkComposed,
|
|
110
|
+
className: className,
|
|
111
|
+
ref: ref
|
|
112
|
+
}, nextjsProps, other));
|
|
113
|
+
});
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
var _Link = require("./Link");
|
|
7
|
+
Object.keys(_Link).forEach(function (key) {
|
|
8
|
+
if (key === "default" || key === "__esModule") return;
|
|
9
|
+
if (key in exports && exports[key] === _Link[key]) return;
|
|
10
|
+
Object.defineProperty(exports, key, {
|
|
11
|
+
enumerable: true,
|
|
12
|
+
get: function () {
|
|
13
|
+
return _Link[key];
|
|
14
|
+
}
|
|
15
|
+
});
|
|
16
|
+
});
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
Object.defineProperty(exports, "__esModule", {
|
|
5
|
+
value: true
|
|
6
|
+
});
|
|
7
|
+
exports.UserLanguageProvider = UserLanguageProvider;
|
|
8
|
+
exports.mapTranslations = mapTranslations;
|
|
9
|
+
exports.useSetUserLanguage = useSetUserLanguage;
|
|
10
|
+
exports.useTranslate = useTranslate;
|
|
11
|
+
exports.useUserLanguage = useUserLanguage;
|
|
12
|
+
var React = _interopRequireWildcard(require("react"));
|
|
13
|
+
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
14
|
+
var _utils = require("@mui/utils");
|
|
15
|
+
var _translations = _interopRequireDefault(require("../translations"));
|
|
16
|
+
var _jsxRuntime = require("react/jsx-runtime");
|
|
17
|
+
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); }
|
|
18
|
+
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; }
|
|
19
|
+
const TranslationsContext = /*#__PURE__*/React.createContext(_translations.default);
|
|
20
|
+
function TranslationsProvider({
|
|
21
|
+
translations = {},
|
|
22
|
+
children
|
|
23
|
+
}) {
|
|
24
|
+
const currentTranslations = React.useContext(TranslationsContext);
|
|
25
|
+
const mergedTranslations = React.useMemo(() => (0, _utils.deepmerge)(currentTranslations, translations), [currentTranslations, translations]);
|
|
26
|
+
return /*#__PURE__*/(0, _jsxRuntime.jsx)(TranslationsContext.Provider, {
|
|
27
|
+
value: mergedTranslations,
|
|
28
|
+
children: children
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
function getPath(obj, path) {
|
|
32
|
+
if (!path || typeof path !== 'string') {
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
return path.split('.').reduce((acc, item) => acc && acc[item] ? acc[item] : null, obj);
|
|
36
|
+
}
|
|
37
|
+
const UserLanguageContext = /*#__PURE__*/React.createContext({
|
|
38
|
+
userLanguage: '',
|
|
39
|
+
setUserLanguage: () => {}
|
|
40
|
+
});
|
|
41
|
+
if (process.env.NODE_ENV !== 'production') {
|
|
42
|
+
UserLanguageContext.displayName = 'UserLanguage';
|
|
43
|
+
}
|
|
44
|
+
function UserLanguageProvider(props) {
|
|
45
|
+
const {
|
|
46
|
+
children,
|
|
47
|
+
translations,
|
|
48
|
+
defaultUserLanguage
|
|
49
|
+
} = props;
|
|
50
|
+
const [userLanguage, setUserLanguage] = React.useState(defaultUserLanguage);
|
|
51
|
+
const contextValue = React.useMemo(() => {
|
|
52
|
+
return {
|
|
53
|
+
userLanguage,
|
|
54
|
+
setUserLanguage
|
|
55
|
+
};
|
|
56
|
+
}, [userLanguage]);
|
|
57
|
+
return /*#__PURE__*/(0, _jsxRuntime.jsx)(TranslationsProvider, {
|
|
58
|
+
translations: translations,
|
|
59
|
+
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(UserLanguageContext.Provider, {
|
|
60
|
+
value: contextValue,
|
|
61
|
+
children: children
|
|
62
|
+
})
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
process.env.NODE_ENV !== "production" ? UserLanguageProvider.propTypes = {
|
|
66
|
+
children: _propTypes.default.node.isRequired,
|
|
67
|
+
defaultUserLanguage: _propTypes.default.string
|
|
68
|
+
} : void 0;
|
|
69
|
+
function useUserLanguage() {
|
|
70
|
+
return React.useContext(UserLanguageContext).userLanguage;
|
|
71
|
+
}
|
|
72
|
+
function useSetUserLanguage() {
|
|
73
|
+
return React.useContext(UserLanguageContext).setUserLanguage;
|
|
74
|
+
}
|
|
75
|
+
const warnedOnce = {};
|
|
76
|
+
function useTranslate() {
|
|
77
|
+
const userLanguage = useUserLanguage();
|
|
78
|
+
const translations = React.useContext(TranslationsContext);
|
|
79
|
+
return React.useMemo(() => function translate(key, options = {}) {
|
|
80
|
+
const {
|
|
81
|
+
ignoreWarning = false
|
|
82
|
+
} = options;
|
|
83
|
+
const wordings = translations[userLanguage];
|
|
84
|
+
if (!wordings) {
|
|
85
|
+
console.error(`Missing language: ${userLanguage}.`);
|
|
86
|
+
return '…';
|
|
87
|
+
}
|
|
88
|
+
const translation = getPath(wordings, key);
|
|
89
|
+
if (!translation) {
|
|
90
|
+
const fullKey = `${userLanguage}:${key}`;
|
|
91
|
+
// No warnings in CI env
|
|
92
|
+
if (!ignoreWarning && !warnedOnce[fullKey] && typeof window !== 'undefined') {
|
|
93
|
+
console.error(`Missing translation for ${fullKey}`);
|
|
94
|
+
warnedOnce[fullKey] = true;
|
|
95
|
+
}
|
|
96
|
+
return getPath(translations.en, key);
|
|
97
|
+
}
|
|
98
|
+
return translation;
|
|
99
|
+
}, [userLanguage, translations]);
|
|
100
|
+
}
|
|
101
|
+
function mapTranslations(req) {
|
|
102
|
+
const result = {};
|
|
103
|
+
req.keys().forEach(filename => {
|
|
104
|
+
const match = filename.match(/-([a-z]{2}).json$/);
|
|
105
|
+
if (match) {
|
|
106
|
+
result[match[1]] = req(filename);
|
|
107
|
+
} else {
|
|
108
|
+
result.en = req(filename);
|
|
109
|
+
}
|
|
110
|
+
});
|
|
111
|
+
return result;
|
|
112
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
var _i18n = require("./i18n");
|
|
7
|
+
Object.keys(_i18n).forEach(function (key) {
|
|
8
|
+
if (key === "default" || key === "__esModule") return;
|
|
9
|
+
if (key in exports && exports[key] === _i18n[key]) return;
|
|
10
|
+
Object.defineProperty(exports, key, {
|
|
11
|
+
enumerable: true,
|
|
12
|
+
get: function () {
|
|
13
|
+
return _i18n[key];
|
|
14
|
+
}
|
|
15
|
+
});
|
|
16
|
+
});
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
Object.defineProperty(exports, "__esModule", {
|
|
5
|
+
value: true
|
|
6
|
+
});
|
|
7
|
+
exports.default = void 0;
|
|
8
|
+
var _translations = _interopRequireDefault(require("./translations.json"));
|
|
9
|
+
var _default = exports.default = {
|
|
10
|
+
en: _translations.default
|
|
11
|
+
};
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mui/docs",
|
|
3
|
-
"version": "5.15.
|
|
3
|
+
"version": "5.15.12",
|
|
4
4
|
"private": false,
|
|
5
5
|
"author": "MUI Team",
|
|
6
6
|
"description": "MUI Docs - Documentation building blocks.",
|
|
7
|
-
"main": "./
|
|
7
|
+
"main": "./index.js",
|
|
8
8
|
"keywords": [
|
|
9
9
|
"react",
|
|
10
10
|
"react-component",
|
|
@@ -24,15 +24,17 @@
|
|
|
24
24
|
"homepage": "https://github.com/mui/material-ui/tree/master/packages/mui-docs",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@babel/runtime": "^7.23.9",
|
|
27
|
+
"clsx": "^2.1.0",
|
|
27
28
|
"nprogress": "^0.2.0",
|
|
28
29
|
"prop-types": "^15.8.1",
|
|
29
|
-
"@mui/
|
|
30
|
-
"@mui/
|
|
30
|
+
"@mui/base": "5.0.0-beta.38",
|
|
31
|
+
"@mui/utils": "^5.15.12"
|
|
31
32
|
},
|
|
32
33
|
"peerDependencies": {
|
|
33
34
|
"@types/react": "^17.0.0 || ^18.0.0",
|
|
35
|
+
"next": "^13.5.1",
|
|
34
36
|
"react": "^17.0.0 || ^18.0.0",
|
|
35
|
-
"@mui/material": "^5.15.
|
|
37
|
+
"@mui/material": "^5.15.12"
|
|
36
38
|
},
|
|
37
39
|
"peerDependenciesMeta": {
|
|
38
40
|
"@types/react": {
|
|
@@ -46,6 +48,5 @@
|
|
|
46
48
|
"engines": {
|
|
47
49
|
"node": ">=12.0.0"
|
|
48
50
|
},
|
|
49
|
-
"module": "./index.js"
|
|
50
|
-
"types": "./index.d.ts"
|
|
51
|
+
"module": "./index.js"
|
|
51
52
|
}
|