Skip to content

Commit d40161b

Browse files
michaldudakmichaldudak
authored
[docs] Reference shared code from the Core monorepo (#326)
1 parent 43c957d commit d40161b

File tree

300 files changed

+714
-21279
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

300 files changed

+714
-21279
lines changed

‎babel.config.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ module.exports = function getBabelConfig(api) {
1717

1818
const defaultAlias = {
1919
'@base_ui/react': resolveAliasPath('./packages/mui-base/src'),
20-
docs: resolveAliasPath('./docs'),
20+
docs: resolveAliasPath('./node_modules/@mui/monorepo/docs'),
21+
'docs-base': resolveAliasPath('./docs'),
2122
test: resolveAliasPath('./test'),
2223
'@mui-internal/api-docs-builder': resolveAliasPath(
2324
'./node_modules/@mui/monorepo/packages/api-docs-builder',

‎docs/babel.config.js

+12
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ const fse = require('fs-extra');
33

44
const errorCodesPath = path.resolve(__dirname, './public/static/error-codes.json');
55

6+
const alias = {
7+
docs: '../node_modules/@mui/monorepo/docs',
8+
'docs-base': './',
9+
};
10+
611
const { version: transformRuntimeVersion } = fse.readJSONSync(
712
require.resolve('@babel/runtime-corejs2/package.json'),
813
);
@@ -31,6 +36,13 @@ module.exports = {
3136
},
3237
},
3338
],
39+
[
40+
'babel-plugin-module-resolver',
41+
{
42+
alias,
43+
transformFunctions: ['require', 'require.context'],
44+
},
45+
],
3446
'babel-plugin-optimize-clsx',
3547
// for IE11 support
3648
'@babel/plugin-transform-object-assign',

‎docs/config.js

+1-29
Original file line numberDiff line numberDiff line change
@@ -1,29 +1 @@
1-
// Valid languages to server-side render in production
2-
const LANGUAGES = ['en'];
3-
4-
// Server side rendered languages
5-
const LANGUAGES_SSR = ['en'];
6-
7-
// Work in progress
8-
const LANGUAGES_IN_PROGRESS = LANGUAGES.slice();
9-
10-
const LANGUAGES_IGNORE_PAGES = (pathname) => {
11-
// We don't have the bandwidth like Qt to translate our blog posts
12-
// https://www.qt.io/zh-cn/blog
13-
if (pathname === '/blog' || pathname.startsWith('/blog/')) {
14-
return true;
15-
}
16-
17-
if (pathname === '/size-snapshot/') {
18-
return true;
19-
}
20-
21-
return false;
22-
};
23-
24-
module.exports = {
25-
LANGUAGES,
26-
LANGUAGES_IN_PROGRESS,
27-
LANGUAGES_SSR,
28-
LANGUAGES_IGNORE_PAGES,
29-
};
1+
module.exports = require('@mui/monorepo/docs/config');

‎docs/data/base/all-components/all-components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
<p class="description">Every Base UI component available so far, sorted alphabetically.</p>
44

5-
{{"component": "modules/components/BaseUIComponents.js"}}
5+
{{"component": "modules/all-components/AllComponents.js"}}

‎docs/next.config.mjs

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ import * as path from 'path';
33
import * as url from 'url';
44
import * as fs from 'fs';
55
import { createRequire } from 'module';
6-
// @ts-expect-error This expected error should be gone once we update the monorepo
76
// eslint-disable-next-line no-restricted-imports
87
import withDocsInfra from '@mui/monorepo/docs/nextConfigDocsInfra.js';
9-
import { findPages } from './src/modules/utils/find.mjs';
8+
import { findPages } from './src/utils/findPages.mjs';
109
import {
1110
LANGUAGES,
1211
LANGUAGES_SSR,
@@ -57,6 +56,8 @@ export default withDocsInfra({
5756
...config.resolve,
5857
alias: {
5958
...config.resolve.alias,
59+
'docs-base': path.resolve(currentDirectory, '../docs'),
60+
docs: path.resolve(currentDirectory, '../node_modules/@mui/monorepo/docs'),
6061
},
6162
},
6263
module: {

‎docs/notifications.json

-22
This file was deleted.

‎docs/package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@
2828
"@emotion/server": "^11.11.0",
2929
"@emotion/styled": "^11.11.5",
3030
"@base_ui/react": "workspace:*",
31-
"@mui/docs": "6.0.0-alpha.3",
31+
"@mui/base": "5.0.0-beta.40",
32+
"@mui/docs": "https://pkg.csb.dev/mui/material-ui/commit/19d7243c/@mui/docs",
3233
"@mui/icons-material": "5.15.15",
33-
"@mui/internal-markdown": "^1.0.1",
34-
"@mui/internal-scripts": "^1.0.3",
34+
"@mui/internal-markdown": "^1.0.3",
35+
"@mui/internal-scripts": "^1.0.6",
3536
"@mui/joy": "5.0.0-beta.32",
3637
"@mui/material": "5.15.15",
3738
"@mui/material-nextjs": "5.15.11",
@@ -81,8 +82,7 @@
8182
"devDependencies": {
8283
"@babel/plugin-transform-react-constant-elements": "^7.24.1",
8384
"@babel/preset-typescript": "^7.24.1",
84-
"@mui/internal-docs-utils": "^1.0.4",
85-
"@mui/internal-scripts": "^1.0.3",
85+
"@mui/internal-docs-utils": "^1.0.6",
8686
"@mui/internal-test-utils": "https://pkg.csb.dev/mui/material-ui/commit/fb183624/@mui/internal-test-utils",
8787
"@types/autosuggest-highlight": "^3.2.3",
8888
"@types/chai": "^4.3.14",

‎docs/pages/_app.js

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import NextHead from 'next/head';
66
import PropTypes from 'prop-types';
77
import { useRouter } from 'next/router';
88
import basePkgJson from 'packages/mui-base/package.json';
9-
import basePages from 'docs/data/base/pages';
9+
import basePages from 'docs-base/data/base/pages';
1010
import PageContext from 'docs/src/modules/components/PageContext';
1111
import GoogleAnalytics from 'docs/src/modules/components/GoogleAnalytics';
1212
import { CodeCopyProvider } from 'docs/src/modules/utils/CodeCopy';
@@ -19,13 +19,16 @@ import findActivePage from 'docs/src/modules/utils/findActivePage';
1919
import { pathnameToLanguage } from 'docs/src/modules/utils/helpers';
2020
import getProductInfoFromUrl from 'docs/src/modules/utils/getProductInfoFromUrl';
2121
import { DocsProvider } from '@mui/docs/DocsProvider';
22+
import configureSandboxDependencies from 'docs-base/src/utils/configureSandboxDependencies';
2223
import './global.css';
2324
import '../public/static/components-gallery/base-theme.css';
2425
import config from '../config';
2526

2627
// Client-side cache, shared for the whole session of the user in the browser.
2728
const clientSideEmotionCache = createEmotionCache();
2829

30+
configureSandboxDependencies();
31+
2932
let reloadInterval;
3033

3134
// Avoid infinite loop when "Upload on reload" is set in the Chrome sw dev tools.

‎docs/pages/_document.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import GlobalStyles from '@mui/material/GlobalStyles';
77
import { getInitColorSchemeScript as getMuiInitColorSchemeScript } from '@mui/material/styles';
88
import { pathnameToLanguage } from 'docs/src/modules/utils/helpers';
99
import createEmotionCache from 'docs/src/createEmotionCache';
10-
import { getMetaThemeColor } from 'docs/src/modules/brandingTheme';
10+
import { getMetaThemeColor } from '@mui/docs/branding';
1111

1212
const PRODUCTION_GA =
1313
process.env.DEPLOY_ENV === 'production' || process.env.DEPLOY_ENV === 'staging';

‎docs/pages/base-ui.tsx

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import BrandingCssVarsProvider from 'docs/src/BrandingCssVarsProvider';
55
import AppHeader from 'docs/src/layouts/AppHeader';
66
import AppFooter from 'docs/src/layouts/AppFooter';
77
import AppHeaderBanner from 'docs/src/components/banner/AppHeaderBanner';
8-
import BaseUIHero from 'docs/src/components/productBaseUI/BaseUIHero';
9-
import BaseUISummary from 'docs/src/components/productBaseUI/BaseUISummary';
10-
import BaseUICustomization from 'docs/src/components/productBaseUI/BaseUICustomization';
11-
import BaseUIEnd from 'docs/src/components/productBaseUI/BaseUIEnd';
12-
import BaseUITestimonial from 'docs/src/components/productBaseUI/BaseUITestimonial';
8+
import BaseUIHero from 'docs-base/src/modules/home/BaseUIHero';
9+
import BaseUISummary from 'docs-base/src/modules/home/BaseUISummary';
10+
import BaseUICustomization from 'docs-base/src/modules/home/BaseUICustomization';
11+
import BaseUIEnd from 'docs-base/src/modules/home/BaseUIEnd';
12+
import BaseUITestimonial from 'docs-base/src/modules/home/BaseUITestimonial';
1313

1414
export default function BaseUI() {
1515
return (

‎docs/pages/base-ui/all-components/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/all-components/all-components.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/all-components/all-components.md?@mui/markdown';
55

66
export default function Page() {
77
return <MarkdownDocs {...pageProps} disableToc />;

‎docs/pages/base-ui/getting-started/accessibility.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/getting-started/accessibility/accessibility.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/getting-started/accessibility/accessibility.md?@mui/markdown';
55

66
export default function Page() {
7-
return <MarkdownDocs {...pageProps} />;
7+
return <MarkdownDocs {...pageProps} disableAd />;
88
}
99

1010
Page.getLayout = (page) => {

‎docs/pages/base-ui/getting-started/customization.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/getting-started/customization/customization.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/getting-started/customization/customization.md?@mui/markdown';
55

66
export default function Page() {
7-
return <MarkdownDocs {...pageProps} />;
7+
return <MarkdownDocs {...pageProps} disableAd />;
88
}
99

1010
Page.getLayout = (page) => {

‎docs/pages/base-ui/getting-started/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/getting-started/overview/overview.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/getting-started/overview/overview.md?@mui/markdown';
55

66
export default function Page() {
77
return <MarkdownDocs {...pageProps} disableAd />;

‎docs/pages/base-ui/getting-started/quickstart.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/getting-started/quickstart/quickstart.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/getting-started/quickstart/quickstart.md?@mui/markdown';
55

66
export default function Page() {
77
return <MarkdownDocs {...pageProps} disableAd />;

‎docs/pages/base-ui/getting-started/support.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import * as React from 'react';
2-
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
3-
import * as pageProps from 'docs/data/base/getting-started/support/support.md?@mui/markdown';
2+
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
3+
import AppFrame from 'docs/src/modules/components/AppFrame';
4+
import * as pageProps from 'docs-base/data/base/getting-started/support/support.md?@mui/markdown';
45

56
export default function Page() {
67
return <MarkdownDocs {...pageProps} disableAd />;
78
}
9+
10+
Page.getLayout = (page) => {
11+
return <AppFrame>{page}</AppFrame>;
12+
};

‎docs/pages/base-ui/getting-started/usage.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/getting-started/usage/usage.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/getting-started/usage/usage.md?@mui/markdown';
55

66
export default function Page() {
77
return <MarkdownDocs {...pageProps} disableAd />;

‎docs/pages/base-ui/guides/next-js-app-router.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import * as React from 'react';
2-
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
3-
import * as pageProps from 'docs/data/base/guides/next-js-app-router/next-js-app-router.md?@mui/markdown';
2+
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
3+
import AppFrame from 'docs/src/modules/components/AppFrame';
4+
import * as pageProps from 'docs-base/data/base/guides/next-js-app-router/next-js-app-router.md?@mui/markdown';
45

56
export default function Page() {
67
return <MarkdownDocs {...pageProps} />;
78
}
9+
10+
Page.getLayout = (page) => {
11+
return <AppFrame>{page}</AppFrame>;
12+
};

‎docs/pages/base-ui/guides/overriding-component-structure.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import * as React from 'react';
2-
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
3-
import * as pageProps from 'docs/data/base/guides/overriding-component-structure/overriding-component-structure.md?@mui/markdown';
2+
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
3+
import AppFrame from 'docs/src/modules/components/AppFrame';
4+
import * as pageProps from 'docs-base/data/base/guides/overriding-component-structure/overriding-component-structure.md?@mui/markdown';
45

56
export default function Page() {
67
return <MarkdownDocs {...pageProps} />;
78
}
9+
10+
Page.getLayout = (page) => {
11+
return <AppFrame>{page}</AppFrame>;
12+
};

‎docs/pages/base-ui/guides/working-with-tailwind-css.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import * as React from 'react';
2-
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
3-
import * as pageProps from 'docs/data/base/guides/working-with-tailwind-css/working-with-tailwind-css.md?@mui/markdown';
2+
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
3+
import AppFrame from 'docs/src/modules/components/AppFrame';
4+
import * as pageProps from 'docs-base/data/base/guides/working-with-tailwind-css/working-with-tailwind-css.md?@mui/markdown';
45

56
export default function Page() {
67
return <MarkdownDocs {...pageProps} />;
78
}
9+
10+
Page.getLayout = (page) => {
11+
return <AppFrame>{page}</AppFrame>;
12+
};

‎docs/pages/base-ui/react-accordion/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/components/accordion/accordion.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/components/accordion/accordion.md?@mui/markdown';
55

66
export default function Page(props) {
77
const { userLanguage, ...other } = props;

‎docs/pages/base-ui/react-autocomplete/[docsTab]/index.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
55
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
66
import useAutocompleteApiJsonPageContent from '../../api/use-autocomplete.json';
77

@@ -23,9 +23,9 @@ export const getStaticPaths = () => {
2323

2424
export const getStaticProps = () => {
2525
const useAutocompleteApiReq = require.context(
26-
'docs/translations/api-docs/use-autocomplete',
26+
'docs-base/translations/api-docs/use-autocomplete',
2727
false,
28-
/use-autocomplete.*.json$/,
28+
/\.\/use-autocomplete.*.json$/,
2929
);
3030
const useAutocompleteApiDescriptions = mapApiPageTranslations(useAutocompleteApiReq);
3131

‎docs/pages/base-ui/react-autocomplete/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/components/autocomplete/autocomplete.md?@mui/markdown';
55

66
export default function Page(props) {
77
const { userLanguage, ...other } = props;

‎docs/pages/base-ui/react-badge/[docsTab]/index.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/components/badge/badge.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/components/badge/badge.md?@mui/markdown';
55
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
66
import BadgeApiJsonPageContent from '../../api/badge.json';
77
import useBadgeApiJsonPageContent from '../../api/use-badge.json';
@@ -24,16 +24,16 @@ export const getStaticPaths = () => {
2424

2525
export const getStaticProps = () => {
2626
const BadgeApiReq = require.context(
27-
'docs/translations/api-docs-base/badge',
27+
'docs-base/translations/api-docs/badge',
2828
false,
29-
/badge.*.json$/,
29+
/\.\/badge.*.json$/,
3030
);
3131
const BadgeApiDescriptions = mapApiPageTranslations(BadgeApiReq);
3232

3333
const useBadgeApiReq = require.context(
34-
'docs/translations/api-docs/use-badge',
34+
'docs-base/translations/api-docs/use-badge',
3535
false,
36-
/use-badge.*.json$/,
36+
/\.\/use-badge.*.json$/,
3737
);
3838
const useBadgeApiDescriptions = mapApiPageTranslations(useBadgeApiReq);
3939

‎docs/pages/base-ui/react-badge/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react';
22
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2';
33
import AppFrame from 'docs/src/modules/components/AppFrame';
4-
import * as pageProps from 'docs/data/base/components/badge/badge.md?@mui/markdown';
4+
import * as pageProps from 'docs-base/data/base/components/badge/badge.md?@mui/markdown';
55

66
export default function Page(props) {
77
const { userLanguage, ...other } = props;

0 commit comments

Comments
 (0)