From a19cafe43b3af50ab9f914fbdfa4b8ebe581e3e1 Mon Sep 17 00:00:00 2001 From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Date: Wed, 8 Feb 2023 14:21:40 -0600 Subject: [PATCH 1/8] standardize example names --- .../.gitignore | 0 .../README.md | 10 ++++---- .../package.json | 4 ++-- .../postcss.config.js | 0 .../public/favicon.ico | Bin .../public/index.html | 0 .../public/logo192.png | Bin .../public/logo512.png | Bin .../public/manifest.json | 0 .../public/robots.txt | 0 .../src/App.tsx | 0 .../src/Button.tsx | 0 .../src/Player.tsx | 0 .../src/Slider.tsx | 0 .../src/index.css | 0 .../src/index.tsx | 0 .../src/logo.svg | 0 .../src/react-app-env.d.ts | 0 .../src/setupTests.ts | 0 .../tailwind.config.js | 0 .../tsconfig.json | 0 .../.gitignore | 0 .../README.md | 10 ++++---- .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../src/App.tsx | 0 .../src/index.tsx | 0 .../src/react-app-env.d.ts | 0 .../tsconfig.json | 0 .../.gitignore | 0 .../README.md | 12 +++++----- .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../src/App.tsx | 0 .../src/index.tsx | 0 .../src/react-app-env.d.ts | 0 .../tsconfig.json | 0 .../.gitignore | 0 .../README.md | 12 +++++----- .../craco.config.js | 0 .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../public/robots.txt | 0 .../src/App.tsx | 2 +- .../src/ProTip.tsx | 2 +- .../src/index.tsx | 0 .../src/react-app-env.d.ts | 0 .../src/setupTests.ts | 0 .../tsconfig.json | 0 .../tsconfig.paths.json | 0 .../.gitignore | 0 .../README.md | 8 +++---- .../craco.config.js | 0 .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../public/robots.txt | 0 .../src/App.js | 2 +- .../src}/ProTip.js | 2 +- .../src/index.js | 0 .../src/serviceWorker.js | 0 .../src/setupTests.js | 0 .../.gitignore | 0 .../README.md | 10 ++++---- .../package.json | 4 ++-- .../postcss.config.js | 0 .../public/favicon.ico | Bin .../public/index.html | 0 .../public/logo192.png | Bin .../public/logo512.png | Bin .../public/manifest.json | 0 .../public/robots.txt | 0 .../src/App.tsx | 2 +- .../src/PopoverMenu.tsx | 0 .../src/ProTip.tsx | 2 +- .../src/index.css | 0 .../src/index.tsx | 0 .../src/logo.svg | 0 .../src/react-app-env.d.ts | 0 .../src/reportWebVitals.ts | 0 .../src/setupTests.ts | 0 .../tailwind.config.js | 2 +- .../tsconfig.json | 0 .../.gitignore | 0 .../README.md | 14 +++++------ .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../src/App.tsx | 2 +- .../app => material-cra-ts}/src/ProTip.tsx | 2 +- .../src/index.tsx | 0 .../src/react-app-env.d.ts | 0 .../src/theme.ts | 0 .../tsconfig.json | 0 .../.gitignore | 0 .../README.md | 14 +++++------ .../package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../src/App.js | 2 +- .../src/ProTip.js | 2 +- .../src/index.js | 0 .../src/theme.js | 0 .../{ssr => material-express-ssr}/.babelrc | 0 .../{ssr => material-express-ssr}/.gitignore | 0 examples/{ssr => material-express-ssr}/App.js | 2 +- .../src => material-express-ssr}/ProTip.js | 2 +- .../{ssr => material-express-ssr}/README.md | 8 +++---- .../{ssr => material-express-ssr}/client.js | 0 .../createEmotionCache.js | 4 ++-- .../package.json | 4 ++-- .../{ssr => material-express-ssr}/server.js | 0 .../src => material-express-ssr}/theme.js | 0 .../webpack.config.js | 0 .../{gatsby => material-gatsby}/.gitignore | 0 .../{gatsby => material-gatsby}/README.md | 8 +++---- .../{gatsby => material-gatsby}/package.json | 4 ++-- .../src/components/Copyright.js | 0 .../src/components/Link.js | 0 .../src/components}/ProTip.js | 2 +- .../src/pages/about.js | 2 +- .../src/pages/index.js | 2 +- .../{gatsby => material-gatsby}/src/theme.js | 0 .../.gitignore | 0 .../README.md | 2 +- .../next.config.js | 0 .../package.json | 4 ++-- .../pages/_app.tsx | 0 .../pages/_document.tsx | 0 .../pages/about.tsx | 2 +- .../pages/index.tsx | 2 +- .../public/favicon.ico | Bin .../src/Copyright.tsx | 0 .../src/Link.tsx | 0 .../src/ProTip.tsx | 2 +- .../src/createEmotionCache.ts | 0 .../src/theme.ts | 0 .../tsconfig.json | 0 .../types/mui-styles.d.ts | 0 .../.gitignore | 0 .../README.md | 12 +++++----- .../next.config.js | 0 .../package.json | 4 ++-- .../pages/_app.tsx | 0 .../pages/_document.tsx | 0 .../pages/about.tsx | 2 +- .../pages/index.tsx | 2 +- .../public/favicon.ico | Bin .../src/Copyright.tsx | 0 .../src/Link.tsx | 0 .../src/ProTip.tsx | 2 +- .../src/createEmotionCache.ts | 0 .../src/theme.ts | 0 .../tsconfig.json | 0 examples/{nextjs => material-next}/.gitignore | 0 examples/{nextjs => material-next}/README.md | 14 +++++------ .../{nextjs => material-next}/next.config.js | 0 .../{nextjs => material-next}/package.json | 4 ++-- .../{nextjs => material-next}/pages/_app.js | 0 .../pages/_document.js | 0 .../{nextjs => material-next}/pages/about.js | 2 +- .../{nextjs => material-next}/pages/index.js | 2 +- .../public/favicon.ico | Bin .../src/Copyright.js | 0 .../{nextjs => material-next}/src/Link.js | 0 examples/material-next/src/ProTip.js | 22 ++++++++++++++++++ .../src/createEmotionCache.js | 0 .../{nextjs => material-next}/src/theme.js | 0 .../{preact => material-preact}/.gitignore | 0 .../{preact => material-preact}/README.md | 10 ++++---- .../config-overrides.js | 0 .../{preact => material-preact}/package.json | 4 ++-- .../public/favicon.ico | Bin .../public/index.html | 0 .../public/manifest.json | 0 .../public/robots.txt | 0 .../{preact => material-preact}/src/App.js | 2 +- .../src/Copyright.js | 0 examples/material-preact/src/ProTip.js | 22 ++++++++++++++++++ .../{preact => material-preact}/src/index.js | 0 .../src/setupTests.js | 0 .../{ssr => material-preact/src}/theme.js | 0 .../.gitignore | 0 .../.stackblitzrc | 0 .../README.md | 14 +++++------ .../app/entry.client.tsx | 0 .../app/entry.server.tsx | 0 .../app/root.tsx | 0 .../app/routes/about.tsx | 2 +- .../app/routes/index.tsx | 2 +- .../app/src/ClientStyleContext.tsx | 0 .../app/src/Copyright.tsx | 0 .../app/src/Layout.tsx | 0 examples/material-remix-ts/app/src/ProTip.tsx | 22 ++++++++++++++++++ .../app/src/createEmotionCache.ts | 0 .../app/src/theme.ts | 0 .../package.json | 4 ++-- .../public/favicon.ico | Bin .../remix.config.js | 0 .../remix.env.d.ts | 0 .../tsconfig.json | 0 examples/{cdn => material-via-cdn}/README.md | 10 ++++---- examples/{cdn => material-via-cdn}/index.html | 4 ++-- .../{cdn => material-via-cdn}/package.json | 4 ++-- .../.gitignore | 0 .../README.md | 12 +++++----- .../index.html | 0 .../package.json | 4 ++-- .../public/vite.svg | 0 .../src/App.tsx | 2 +- examples/material-vite-ts/src/ProTip.tsx | 22 ++++++++++++++++++ .../src/main.tsx | 0 .../src/theme.tsx | 0 .../src/vite-env.d.ts | 0 .../tsconfig.json | 0 .../tsconfig.node.json | 0 .../vite.config.ts | 0 examples/{vitejs => material-vite}/.gitignore | 0 examples/{vitejs => material-vite}/README.md | 12 +++++----- examples/{vitejs => material-vite}/index.html | 0 .../{vitejs => material-vite}/package.json | 4 ++-- .../{vitejs => material-vite}/src/App.jsx | 2 +- .../src/Copyright.jsx | 0 .../{vitejs => material-vite}/src/ProTip.jsx | 2 +- .../{vitejs => material-vite}/src/main.jsx | 0 .../{vitejs => material-vite}/src/theme.js | 0 .../{vitejs => material-vite}/vite.config.js | 0 examples/preact/src/ProTip.js | 22 ------------------ examples/ssr/ProTip.js | 22 ------------------ examples/tailwind-css/src/ProTip.tsx | 22 ------------------ .../vitejs-with-typescript/src/ProTip.tsx | 22 ------------------ 240 files changed, 254 insertions(+), 254 deletions(-) rename examples/{create-react-app-with-styled-components-typescript => base-cra-tailwind-ts}/.gitignore (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/README.md (75%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/package.json (95%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/postcss.config.js (100%) rename examples/{base-cra-typescript => base-cra-tailwind-ts}/public/favicon.ico (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/public/index.html (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/public/logo192.png (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/public/logo512.png (100%) rename examples/{create-react-app-with-styled-components-typescript => base-cra-tailwind-ts}/public/manifest.json (100%) rename examples/{create-react-app-with-styled-components-typescript => base-cra-tailwind-ts}/public/robots.txt (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/App.tsx (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/Button.tsx (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/Player.tsx (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/Slider.tsx (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/index.css (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/index.tsx (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/logo.svg (100%) rename examples/{base-cra-typescript => base-cra-tailwind-ts}/src/react-app-env.d.ts (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/src/setupTests.ts (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/tailwind.config.js (100%) rename examples/{mui-base-with-tailwind-css => base-cra-tailwind-ts}/tsconfig.json (100%) rename examples/{base-cra-typescript => base-cra-ts}/.gitignore (100%) rename examples/{base-cra-typescript => base-cra-ts}/README.md (78%) rename examples/{base-cra-typescript => base-cra-ts}/package.json (95%) rename examples/{create-react-app-with-typescript => base-cra-ts}/public/favicon.ico (100%) rename examples/{base-cra-typescript => base-cra-ts}/public/index.html (100%) rename examples/{base-cra-typescript => base-cra-ts}/public/manifest.json (100%) rename examples/{base-cra-typescript => base-cra-ts}/src/App.tsx (100%) rename examples/{base-cra-typescript => base-cra-ts}/src/index.tsx (100%) rename examples/{create-react-app-with-styled-components-typescript => base-cra-ts}/src/react-app-env.d.ts (100%) rename examples/{base-cra-typescript => base-cra-ts}/tsconfig.json (100%) rename examples/{create-react-app-with-typescript => joy-cra-ts}/.gitignore (100%) rename examples/{joy-cra-typescript => joy-cra-ts}/README.md (65%) rename examples/{joy-cra-typescript => joy-cra-ts}/package.json (95%) rename examples/{create-react-app => joy-cra-ts}/public/favicon.ico (100%) rename examples/{create-react-app-with-typescript => joy-cra-ts}/public/index.html (100%) rename examples/{create-react-app-with-typescript => joy-cra-ts}/public/manifest.json (100%) rename examples/{joy-cra-typescript => joy-cra-ts}/src/App.tsx (100%) rename examples/{joy-cra-typescript => joy-cra-ts}/src/index.tsx (100%) rename examples/{create-react-app-with-typescript => joy-cra-ts}/src/react-app-env.d.ts (100%) rename examples/{create-react-app-with-typescript => joy-cra-ts}/tsconfig.json (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components-ts}/.gitignore (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/README.md (66%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/craco.config.js (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/package.json (94%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/public/favicon.ico (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/public/index.html (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components-ts}/public/manifest.json (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components-ts}/public/robots.txt (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/src/App.tsx (90%) rename examples/{create-react-app-with-typescript => material-cra-styled-components-ts}/src/ProTip.tsx (96%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/src/index.tsx (100%) rename examples/{joy-cra-typescript => material-cra-styled-components-ts}/src/react-app-env.d.ts (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/src/setupTests.ts (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/tsconfig.json (100%) rename examples/{create-react-app-with-styled-components-typescript => material-cra-styled-components-ts}/tsconfig.paths.json (100%) rename examples/{mui-base-with-tailwind-css => material-cra-styled-components}/.gitignore (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/README.md (82%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/craco.config.js (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/package.json (93%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/public/favicon.ico (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/public/index.html (100%) rename examples/{mui-base-with-tailwind-css => material-cra-styled-components}/public/manifest.json (100%) rename examples/{mui-base-with-tailwind-css => material-cra-styled-components}/public/robots.txt (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/src/App.js (91%) rename examples/{gatsby/src/components => material-cra-styled-components/src}/ProTip.js (95%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/src/index.js (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/src/serviceWorker.js (100%) rename examples/{create-react-app-with-styled-components => material-cra-styled-components}/src/setupTests.js (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/.gitignore (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/README.md (80%) rename examples/{tailwind-css => material-cra-tailwind-ts}/package.json (96%) rename examples/{tailwind-css => material-cra-tailwind-ts}/postcss.config.js (100%) rename examples/{joy-cra-typescript => material-cra-tailwind-ts}/public/favicon.ico (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/public/index.html (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/public/logo192.png (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/public/logo512.png (100%) rename examples/{preact => material-cra-tailwind-ts}/public/manifest.json (100%) rename examples/{preact => material-cra-tailwind-ts}/public/robots.txt (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/App.tsx (93%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/PopoverMenu.tsx (100%) rename examples/{nextjs-with-typescript => material-cra-tailwind-ts}/src/ProTip.tsx (96%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/index.css (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/index.tsx (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/logo.svg (100%) rename examples/{mui-base-with-tailwind-css => material-cra-tailwind-ts}/src/react-app-env.d.ts (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/reportWebVitals.ts (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/src/setupTests.ts (100%) rename examples/{tailwind-css => material-cra-tailwind-ts}/tailwind.config.js (62%) rename examples/{tailwind-css => material-cra-tailwind-ts}/tsconfig.json (100%) rename examples/{create-react-app => material-cra-ts}/.gitignore (100%) rename examples/{create-react-app-with-typescript => material-cra-ts}/README.md (67%) rename examples/{create-react-app-with-typescript => material-cra-ts}/package.json (93%) rename examples/{mui-base-with-tailwind-css => material-cra-ts}/public/favicon.ico (100%) rename examples/{create-react-app => material-cra-ts}/public/index.html (100%) rename examples/{create-react-app => material-cra-ts}/public/manifest.json (100%) rename examples/{create-react-app-with-typescript => material-cra-ts}/src/App.tsx (92%) rename examples/{remix-with-typescript/app => material-cra-ts}/src/ProTip.tsx (96%) rename examples/{create-react-app-with-typescript => material-cra-ts}/src/index.tsx (100%) rename examples/{tailwind-css => material-cra-ts}/src/react-app-env.d.ts (100%) rename examples/{create-react-app-with-typescript => material-cra-ts}/src/theme.ts (100%) rename examples/{joy-cra-typescript => material-cra-ts}/tsconfig.json (100%) rename examples/{joy-cra-typescript => material-cra}/.gitignore (100%) rename examples/{create-react-app => material-cra}/README.md (78%) rename examples/{create-react-app => material-cra}/package.json (95%) rename examples/{tailwind-css => material-cra}/public/favicon.ico (100%) rename examples/{joy-cra-typescript => material-cra}/public/index.html (100%) rename examples/{joy-cra-typescript => material-cra}/public/manifest.json (100%) rename examples/{create-react-app => material-cra}/src/App.js (94%) rename examples/{create-react-app-with-styled-components => material-cra}/src/ProTip.js (95%) rename examples/{create-react-app => material-cra}/src/index.js (100%) rename examples/{create-react-app => material-cra}/src/theme.js (100%) rename examples/{ssr => material-express-ssr}/.babelrc (100%) rename examples/{ssr => material-express-ssr}/.gitignore (100%) rename examples/{ssr => material-express-ssr}/App.js (93%) rename examples/{create-react-app/src => material-express-ssr}/ProTip.js (95%) rename examples/{ssr => material-express-ssr}/README.md (80%) rename examples/{ssr => material-express-ssr}/client.js (100%) rename examples/{ssr => material-express-ssr}/createEmotionCache.js (74%) rename examples/{ssr => material-express-ssr}/package.json (96%) rename examples/{ssr => material-express-ssr}/server.js (100%) rename examples/{preact/src => material-express-ssr}/theme.js (100%) rename examples/{ssr => material-express-ssr}/webpack.config.js (100%) rename examples/{gatsby => material-gatsby}/.gitignore (100%) rename examples/{gatsby => material-gatsby}/README.md (83%) rename examples/{gatsby => material-gatsby}/package.json (95%) rename examples/{gatsby => material-gatsby}/src/components/Copyright.js (100%) rename examples/{gatsby => material-gatsby}/src/components/Link.js (100%) rename examples/{nextjs/src => material-gatsby/src/components}/ProTip.js (95%) rename examples/{gatsby => material-gatsby}/src/pages/about.js (94%) rename examples/{gatsby => material-gatsby}/src/pages/index.js (94%) rename examples/{gatsby => material-gatsby}/src/theme.js (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/.gitignore (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/README.md (91%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/next.config.js (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/package.json (93%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/pages/_app.tsx (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/pages/_document.tsx (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/pages/about.tsx (93%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/pages/index.tsx (92%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/public/favicon.ico (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/src/Copyright.tsx (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/src/Link.tsx (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/src/ProTip.tsx (96%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/src/createEmotionCache.ts (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/src/theme.ts (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/tsconfig.json (100%) rename examples/{nextjs-with-typescript-v4-migration => material-next-ts-v4-v5-migration}/types/mui-styles.d.ts (100%) rename examples/{nextjs-with-typescript => material-next-ts}/.gitignore (100%) rename examples/{nextjs-with-typescript => material-next-ts}/README.md (77%) rename examples/{nextjs-with-typescript => material-next-ts}/next.config.js (100%) rename examples/{nextjs-with-typescript => material-next-ts}/package.json (95%) rename examples/{nextjs-with-typescript => material-next-ts}/pages/_app.tsx (100%) rename examples/{nextjs-with-typescript => material-next-ts}/pages/_document.tsx (100%) rename examples/{nextjs-with-typescript => material-next-ts}/pages/about.tsx (94%) rename examples/{nextjs-with-typescript => material-next-ts}/pages/index.tsx (93%) rename examples/{nextjs-with-typescript => material-next-ts}/public/favicon.ico (100%) rename examples/{nextjs-with-typescript => material-next-ts}/src/Copyright.tsx (100%) rename examples/{nextjs-with-typescript => material-next-ts}/src/Link.tsx (100%) rename examples/{create-react-app-with-styled-components-typescript => material-next-ts}/src/ProTip.tsx (96%) rename examples/{nextjs-with-typescript => material-next-ts}/src/createEmotionCache.ts (100%) rename examples/{nextjs-with-typescript => material-next-ts}/src/theme.ts (100%) rename examples/{nextjs-with-typescript => material-next-ts}/tsconfig.json (100%) rename examples/{nextjs => material-next}/.gitignore (100%) rename examples/{nextjs => material-next}/README.md (84%) rename examples/{nextjs => material-next}/next.config.js (100%) rename examples/{nextjs => material-next}/package.json (96%) rename examples/{nextjs => material-next}/pages/_app.js (100%) rename examples/{nextjs => material-next}/pages/_document.js (100%) rename examples/{nextjs => material-next}/pages/about.js (94%) rename examples/{nextjs => material-next}/pages/index.js (94%) rename examples/{nextjs => material-next}/public/favicon.ico (100%) rename examples/{nextjs => material-next}/src/Copyright.js (100%) rename examples/{nextjs => material-next}/src/Link.js (100%) create mode 100644 examples/material-next/src/ProTip.js rename examples/{nextjs => material-next}/src/createEmotionCache.js (100%) rename examples/{nextjs => material-next}/src/theme.js (100%) rename examples/{preact => material-preact}/.gitignore (100%) rename examples/{preact => material-preact}/README.md (72%) rename examples/{preact => material-preact}/config-overrides.js (100%) rename examples/{preact => material-preact}/package.json (96%) rename examples/{preact => material-preact}/public/favicon.ico (100%) rename examples/{preact => material-preact}/public/index.html (100%) rename examples/{tailwind-css => material-preact}/public/manifest.json (100%) rename examples/{tailwind-css => material-preact}/public/robots.txt (100%) rename examples/{preact => material-preact}/src/App.js (93%) rename examples/{preact => material-preact}/src/Copyright.js (100%) create mode 100644 examples/material-preact/src/ProTip.js rename examples/{preact => material-preact}/src/index.js (100%) rename examples/{preact => material-preact}/src/setupTests.js (100%) rename examples/{ssr => material-preact/src}/theme.js (100%) rename examples/{remix-with-typescript => material-remix-ts}/.gitignore (100%) rename examples/{remix-with-typescript => material-remix-ts}/.stackblitzrc (100%) rename examples/{remix-with-typescript => material-remix-ts}/README.md (72%) rename examples/{remix-with-typescript => material-remix-ts}/app/entry.client.tsx (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/entry.server.tsx (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/root.tsx (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/routes/about.tsx (90%) rename examples/{remix-with-typescript => material-remix-ts}/app/routes/index.tsx (92%) rename examples/{remix-with-typescript => material-remix-ts}/app/src/ClientStyleContext.tsx (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/src/Copyright.tsx (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/src/Layout.tsx (100%) create mode 100644 examples/material-remix-ts/app/src/ProTip.tsx rename examples/{remix-with-typescript => material-remix-ts}/app/src/createEmotionCache.ts (100%) rename examples/{remix-with-typescript => material-remix-ts}/app/src/theme.ts (100%) rename examples/{remix-with-typescript => material-remix-ts}/package.json (95%) rename examples/{remix-with-typescript => material-remix-ts}/public/favicon.ico (100%) rename examples/{remix-with-typescript => material-remix-ts}/remix.config.js (100%) rename examples/{remix-with-typescript => material-remix-ts}/remix.env.d.ts (100%) rename examples/{remix-with-typescript => material-remix-ts}/tsconfig.json (100%) rename examples/{cdn => material-via-cdn}/README.md (80%) rename examples/{cdn => material-via-cdn}/index.html (97%) rename examples/{cdn => material-via-cdn}/package.json (72%) rename examples/{vitejs-with-typescript => material-vite-ts}/.gitignore (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/README.md (75%) rename examples/{vitejs-with-typescript => material-vite-ts}/index.html (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/package.json (93%) rename examples/{vitejs-with-typescript => material-vite-ts}/public/vite.svg (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/src/App.tsx (93%) create mode 100644 examples/material-vite-ts/src/ProTip.tsx rename examples/{vitejs-with-typescript => material-vite-ts}/src/main.tsx (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/src/theme.tsx (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/src/vite-env.d.ts (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/tsconfig.json (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/tsconfig.node.json (100%) rename examples/{vitejs-with-typescript => material-vite-ts}/vite.config.ts (100%) rename examples/{vitejs => material-vite}/.gitignore (100%) rename examples/{vitejs => material-vite}/README.md (80%) rename examples/{vitejs => material-vite}/index.html (100%) rename examples/{vitejs => material-vite}/package.json (93%) rename examples/{vitejs => material-vite}/src/App.jsx (92%) rename examples/{vitejs => material-vite}/src/Copyright.jsx (100%) rename examples/{vitejs => material-vite}/src/ProTip.jsx (95%) rename examples/{vitejs => material-vite}/src/main.jsx (100%) rename examples/{vitejs => material-vite}/src/theme.js (100%) rename examples/{vitejs => material-vite}/vite.config.js (100%) delete mode 100644 examples/preact/src/ProTip.js delete mode 100644 examples/ssr/ProTip.js delete mode 100644 examples/tailwind-css/src/ProTip.tsx delete mode 100644 examples/vitejs-with-typescript/src/ProTip.tsx diff --git a/examples/create-react-app-with-styled-components-typescript/.gitignore b/examples/base-cra-tailwind-ts/.gitignore similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/.gitignore rename to examples/base-cra-tailwind-ts/.gitignore diff --git a/examples/mui-base-with-tailwind-css/README.md b/examples/base-cra-tailwind-ts/README.md similarity index 75% rename from examples/mui-base-with-tailwind-css/README.md rename to examples/base-cra-tailwind-ts/README.md index 2033fd3d4fdf51..d3d1d0b167b8e3 100644 --- a/examples/mui-base-with-tailwind-css/README.md +++ b/examples/base-cra-tailwind-ts/README.md @@ -1,4 +1,4 @@ -# Create React App example with MUI Base & Tailwind CSS +# MUI Base - Create React App example with Tailwind CSS in TypeScript ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/mui-base-with-tailwind-css -cd mui-base-with-tailwind-css +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/base-cra-tailwind-ts +cd base-cra-tailwind-ts ``` Install it and run: @@ -22,9 +22,9 @@ or: -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/mui-base-with-tailwind-css) +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/base-cra-tailwind-ts) -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/mui-base-with-tailwind-css) +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/base-cra-tailwind-ts) ## The idea behind the example diff --git a/examples/mui-base-with-tailwind-css/package.json b/examples/base-cra-tailwind-ts/package.json similarity index 95% rename from examples/mui-base-with-tailwind-css/package.json rename to examples/base-cra-tailwind-ts/package.json index ca707632e19082..292ec5141b8bf3 100644 --- a/examples/mui-base-with-tailwind-css/package.json +++ b/examples/base-cra-tailwind-ts/package.json @@ -1,5 +1,5 @@ { - "name": "mui-base-with-tailwind-css", + "name": "base-cra-tailwind-ts", "version": "0.1.0", "private": true, "dependencies": { @@ -36,4 +36,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/mui-base-with-tailwind-css/postcss.config.js b/examples/base-cra-tailwind-ts/postcss.config.js similarity index 100% rename from examples/mui-base-with-tailwind-css/postcss.config.js rename to examples/base-cra-tailwind-ts/postcss.config.js diff --git a/examples/base-cra-typescript/public/favicon.ico b/examples/base-cra-tailwind-ts/public/favicon.ico similarity index 100% rename from examples/base-cra-typescript/public/favicon.ico rename to examples/base-cra-tailwind-ts/public/favicon.ico diff --git a/examples/mui-base-with-tailwind-css/public/index.html b/examples/base-cra-tailwind-ts/public/index.html similarity index 100% rename from examples/mui-base-with-tailwind-css/public/index.html rename to examples/base-cra-tailwind-ts/public/index.html diff --git a/examples/mui-base-with-tailwind-css/public/logo192.png b/examples/base-cra-tailwind-ts/public/logo192.png similarity index 100% rename from examples/mui-base-with-tailwind-css/public/logo192.png rename to examples/base-cra-tailwind-ts/public/logo192.png diff --git a/examples/mui-base-with-tailwind-css/public/logo512.png b/examples/base-cra-tailwind-ts/public/logo512.png similarity index 100% rename from examples/mui-base-with-tailwind-css/public/logo512.png rename to examples/base-cra-tailwind-ts/public/logo512.png diff --git a/examples/create-react-app-with-styled-components-typescript/public/manifest.json b/examples/base-cra-tailwind-ts/public/manifest.json similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/public/manifest.json rename to examples/base-cra-tailwind-ts/public/manifest.json diff --git a/examples/create-react-app-with-styled-components-typescript/public/robots.txt b/examples/base-cra-tailwind-ts/public/robots.txt similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/public/robots.txt rename to examples/base-cra-tailwind-ts/public/robots.txt diff --git a/examples/mui-base-with-tailwind-css/src/App.tsx b/examples/base-cra-tailwind-ts/src/App.tsx similarity index 100% rename from examples/mui-base-with-tailwind-css/src/App.tsx rename to examples/base-cra-tailwind-ts/src/App.tsx diff --git a/examples/mui-base-with-tailwind-css/src/Button.tsx b/examples/base-cra-tailwind-ts/src/Button.tsx similarity index 100% rename from examples/mui-base-with-tailwind-css/src/Button.tsx rename to examples/base-cra-tailwind-ts/src/Button.tsx diff --git a/examples/mui-base-with-tailwind-css/src/Player.tsx b/examples/base-cra-tailwind-ts/src/Player.tsx similarity index 100% rename from examples/mui-base-with-tailwind-css/src/Player.tsx rename to examples/base-cra-tailwind-ts/src/Player.tsx diff --git a/examples/mui-base-with-tailwind-css/src/Slider.tsx b/examples/base-cra-tailwind-ts/src/Slider.tsx similarity index 100% rename from examples/mui-base-with-tailwind-css/src/Slider.tsx rename to examples/base-cra-tailwind-ts/src/Slider.tsx diff --git a/examples/mui-base-with-tailwind-css/src/index.css b/examples/base-cra-tailwind-ts/src/index.css similarity index 100% rename from examples/mui-base-with-tailwind-css/src/index.css rename to examples/base-cra-tailwind-ts/src/index.css diff --git a/examples/mui-base-with-tailwind-css/src/index.tsx b/examples/base-cra-tailwind-ts/src/index.tsx similarity index 100% rename from examples/mui-base-with-tailwind-css/src/index.tsx rename to examples/base-cra-tailwind-ts/src/index.tsx diff --git a/examples/mui-base-with-tailwind-css/src/logo.svg b/examples/base-cra-tailwind-ts/src/logo.svg similarity index 100% rename from examples/mui-base-with-tailwind-css/src/logo.svg rename to examples/base-cra-tailwind-ts/src/logo.svg diff --git a/examples/base-cra-typescript/src/react-app-env.d.ts b/examples/base-cra-tailwind-ts/src/react-app-env.d.ts similarity index 100% rename from examples/base-cra-typescript/src/react-app-env.d.ts rename to examples/base-cra-tailwind-ts/src/react-app-env.d.ts diff --git a/examples/mui-base-with-tailwind-css/src/setupTests.ts b/examples/base-cra-tailwind-ts/src/setupTests.ts similarity index 100% rename from examples/mui-base-with-tailwind-css/src/setupTests.ts rename to examples/base-cra-tailwind-ts/src/setupTests.ts diff --git a/examples/mui-base-with-tailwind-css/tailwind.config.js b/examples/base-cra-tailwind-ts/tailwind.config.js similarity index 100% rename from examples/mui-base-with-tailwind-css/tailwind.config.js rename to examples/base-cra-tailwind-ts/tailwind.config.js diff --git a/examples/mui-base-with-tailwind-css/tsconfig.json b/examples/base-cra-tailwind-ts/tsconfig.json similarity index 100% rename from examples/mui-base-with-tailwind-css/tsconfig.json rename to examples/base-cra-tailwind-ts/tsconfig.json diff --git a/examples/base-cra-typescript/.gitignore b/examples/base-cra-ts/.gitignore similarity index 100% rename from examples/base-cra-typescript/.gitignore rename to examples/base-cra-ts/.gitignore diff --git a/examples/base-cra-typescript/README.md b/examples/base-cra-ts/README.md similarity index 78% rename from examples/base-cra-typescript/README.md rename to examples/base-cra-ts/README.md index 5b511a7b861a1f..2b7dd88ec4db4c 100644 --- a/examples/base-cra-typescript/README.md +++ b/examples/base-cra-ts/README.md @@ -1,4 +1,4 @@ -# Create React App example with TypeScript +# MUI Base - Create React App example with TypeScript [MUI Base](https://mui.com/base/getting-started/overview/) is a library of unstyled React UI components which includes prebuilt components with production-ready functionality, along with low-level hooks for transferring that functionality to other components. @@ -9,8 +9,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/base-cra-typescript -cd base-cra-typescript +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/base-cra-ts +cd base-cra-ts ``` Install it and run: @@ -24,6 +24,6 @@ or: -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/base-cra-typescript) +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/base-cra-ts) -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/base-cra-typescript) +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/base-cra-ts) diff --git a/examples/base-cra-typescript/package.json b/examples/base-cra-ts/package.json similarity index 95% rename from examples/base-cra-typescript/package.json rename to examples/base-cra-ts/package.json index 2f1fb406aaa257..5a7ff5935961b7 100644 --- a/examples/base-cra-typescript/package.json +++ b/examples/base-cra-ts/package.json @@ -1,5 +1,5 @@ { - "name": "base-cra-typescript", + "name": "base-cra-ts", "version": "5.0.0", "private": true, "dependencies": { @@ -32,4 +32,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/create-react-app-with-typescript/public/favicon.ico b/examples/base-cra-ts/public/favicon.ico similarity index 100% rename from examples/create-react-app-with-typescript/public/favicon.ico rename to examples/base-cra-ts/public/favicon.ico diff --git a/examples/base-cra-typescript/public/index.html b/examples/base-cra-ts/public/index.html similarity index 100% rename from examples/base-cra-typescript/public/index.html rename to examples/base-cra-ts/public/index.html diff --git a/examples/base-cra-typescript/public/manifest.json b/examples/base-cra-ts/public/manifest.json similarity index 100% rename from examples/base-cra-typescript/public/manifest.json rename to examples/base-cra-ts/public/manifest.json diff --git a/examples/base-cra-typescript/src/App.tsx b/examples/base-cra-ts/src/App.tsx similarity index 100% rename from examples/base-cra-typescript/src/App.tsx rename to examples/base-cra-ts/src/App.tsx diff --git a/examples/base-cra-typescript/src/index.tsx b/examples/base-cra-ts/src/index.tsx similarity index 100% rename from examples/base-cra-typescript/src/index.tsx rename to examples/base-cra-ts/src/index.tsx diff --git a/examples/create-react-app-with-styled-components-typescript/src/react-app-env.d.ts b/examples/base-cra-ts/src/react-app-env.d.ts similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/src/react-app-env.d.ts rename to examples/base-cra-ts/src/react-app-env.d.ts diff --git a/examples/base-cra-typescript/tsconfig.json b/examples/base-cra-ts/tsconfig.json similarity index 100% rename from examples/base-cra-typescript/tsconfig.json rename to examples/base-cra-ts/tsconfig.json diff --git a/examples/create-react-app-with-typescript/.gitignore b/examples/joy-cra-ts/.gitignore similarity index 100% rename from examples/create-react-app-with-typescript/.gitignore rename to examples/joy-cra-ts/.gitignore diff --git a/examples/joy-cra-typescript/README.md b/examples/joy-cra-ts/README.md similarity index 65% rename from examples/joy-cra-typescript/README.md rename to examples/joy-cra-ts/README.md index 74ff6fd4c5ed4e..1174ee14f4d596 100644 --- a/examples/joy-cra-typescript/README.md +++ b/examples/joy-cra-ts/README.md @@ -1,6 +1,6 @@ -# Create React App example with TypeScript +# Joy UI - Create React App example in TypeScript -## `@mui/joy` is still in early development, DO NOT use it in production +`@mui/joy` is still in early development and is not recommended for use in production. ## How to use @@ -9,8 +9,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/joy-cra-typescript -cd joy-cra-typescript +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/joy-cra-ts +cd joy-cra-ts ``` Install it and run: @@ -24,6 +24,6 @@ or: -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/joy-cra-typescript) +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/joy-cra-ts) -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/joy-cra-typescript) +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/joy-cra-ts) diff --git a/examples/joy-cra-typescript/package.json b/examples/joy-cra-ts/package.json similarity index 95% rename from examples/joy-cra-typescript/package.json rename to examples/joy-cra-ts/package.json index b9a833d5944190..b4c7c9111c28d6 100644 --- a/examples/joy-cra-typescript/package.json +++ b/examples/joy-cra-ts/package.json @@ -1,5 +1,5 @@ { - "name": "joy-cra-typescript", + "name": "joy-cra-ts", "version": "5.0.0", "private": true, "dependencies": { @@ -31,4 +31,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/create-react-app/public/favicon.ico b/examples/joy-cra-ts/public/favicon.ico similarity index 100% rename from examples/create-react-app/public/favicon.ico rename to examples/joy-cra-ts/public/favicon.ico diff --git a/examples/create-react-app-with-typescript/public/index.html b/examples/joy-cra-ts/public/index.html similarity index 100% rename from examples/create-react-app-with-typescript/public/index.html rename to examples/joy-cra-ts/public/index.html diff --git a/examples/create-react-app-with-typescript/public/manifest.json b/examples/joy-cra-ts/public/manifest.json similarity index 100% rename from examples/create-react-app-with-typescript/public/manifest.json rename to examples/joy-cra-ts/public/manifest.json diff --git a/examples/joy-cra-typescript/src/App.tsx b/examples/joy-cra-ts/src/App.tsx similarity index 100% rename from examples/joy-cra-typescript/src/App.tsx rename to examples/joy-cra-ts/src/App.tsx diff --git a/examples/joy-cra-typescript/src/index.tsx b/examples/joy-cra-ts/src/index.tsx similarity index 100% rename from examples/joy-cra-typescript/src/index.tsx rename to examples/joy-cra-ts/src/index.tsx diff --git a/examples/create-react-app-with-typescript/src/react-app-env.d.ts b/examples/joy-cra-ts/src/react-app-env.d.ts similarity index 100% rename from examples/create-react-app-with-typescript/src/react-app-env.d.ts rename to examples/joy-cra-ts/src/react-app-env.d.ts diff --git a/examples/create-react-app-with-typescript/tsconfig.json b/examples/joy-cra-ts/tsconfig.json similarity index 100% rename from examples/create-react-app-with-typescript/tsconfig.json rename to examples/joy-cra-ts/tsconfig.json diff --git a/examples/create-react-app-with-styled-components/.gitignore b/examples/material-cra-styled-components-ts/.gitignore similarity index 100% rename from examples/create-react-app-with-styled-components/.gitignore rename to examples/material-cra-styled-components-ts/.gitignore diff --git a/examples/create-react-app-with-styled-components-typescript/README.md b/examples/material-cra-styled-components-ts/README.md similarity index 66% rename from examples/create-react-app-with-styled-components-typescript/README.md rename to examples/material-cra-styled-components-ts/README.md index a4b48a59e76337..c7b8f72d9533c3 100644 --- a/examples/create-react-app-with-styled-components-typescript/README.md +++ b/examples/material-cra-styled-components-ts/README.md @@ -1,6 +1,6 @@ -# Create React App example with styled-components & TypeScript +# Material UI - Create React App example with styled-components in TypeScript -The main difference between this and the non-typescript example is that you need to add the following path config to your tsconfig: +The main difference between this and the non-TypeScript example is that you need to add the following path config to your `tsconfig.json`: ```json "paths": { @@ -23,8 +23,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-styled-components-typescript -cd create-react-app-with-styled-components-typescript +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-cra-styled-components-ts +cd material-cra-styled-components-ts ``` Install it and run: @@ -38,7 +38,7 @@ npm start -Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-styled-components-typescript). +Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/material-cra-styled-components-ts). The following link leverages this demo: https://mui.com/guides/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json` @@ -46,7 +46,7 @@ The following link leverages this demo: https://mui.com/guides/interoperability/ ## The idea behind the example -This example demonstrates how you can setup [Create React App](https://github.com/facebookincubator/create-react-app) with [styled-components](https://styled-components.com/) as a style engine for your application using TypeScript. +This example demonstrates how to set up Material UI with [Create React App](https://github.com/facebookincubator/create-react-app) with [styled-components](https://styled-components.com/) as a style engine for your application using TypeScript. ## What's next? diff --git a/examples/create-react-app-with-styled-components-typescript/craco.config.js b/examples/material-cra-styled-components-ts/craco.config.js similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/craco.config.js rename to examples/material-cra-styled-components-ts/craco.config.js diff --git a/examples/create-react-app-with-styled-components-typescript/package.json b/examples/material-cra-styled-components-ts/package.json similarity index 94% rename from examples/create-react-app-with-styled-components-typescript/package.json rename to examples/material-cra-styled-components-ts/package.json index c769e6ff9a63f9..00c0eaa8fc32fe 100644 --- a/examples/create-react-app-with-styled-components-typescript/package.json +++ b/examples/material-cra-styled-components-ts/package.json @@ -1,5 +1,5 @@ { - "name": "create-react-app-with-styled-components-typescript", + "name": "material-cra-styled-components-ts", "version": "5.0.0", "private": true, "dependencies": { @@ -42,4 +42,4 @@ "craco-alias": "^3.0.1", "typescript": "latest" } -} +} \ No newline at end of file diff --git a/examples/create-react-app-with-styled-components-typescript/public/favicon.ico b/examples/material-cra-styled-components-ts/public/favicon.ico similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/public/favicon.ico rename to examples/material-cra-styled-components-ts/public/favicon.ico diff --git a/examples/create-react-app-with-styled-components-typescript/public/index.html b/examples/material-cra-styled-components-ts/public/index.html similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/public/index.html rename to examples/material-cra-styled-components-ts/public/index.html diff --git a/examples/create-react-app-with-styled-components/public/manifest.json b/examples/material-cra-styled-components-ts/public/manifest.json similarity index 100% rename from examples/create-react-app-with-styled-components/public/manifest.json rename to examples/material-cra-styled-components-ts/public/manifest.json diff --git a/examples/create-react-app-with-styled-components/public/robots.txt b/examples/material-cra-styled-components-ts/public/robots.txt similarity index 100% rename from examples/create-react-app-with-styled-components/public/robots.txt rename to examples/material-cra-styled-components-ts/public/robots.txt diff --git a/examples/create-react-app-with-styled-components-typescript/src/App.tsx b/examples/material-cra-styled-components-ts/src/App.tsx similarity index 90% rename from examples/create-react-app-with-styled-components-typescript/src/App.tsx rename to examples/material-cra-styled-components-ts/src/App.tsx index a0219037e40ed1..3747ecde982cde 100644 --- a/examples/create-react-app-with-styled-components-typescript/src/App.tsx +++ b/examples/material-cra-styled-components-ts/src/App.tsx @@ -22,7 +22,7 @@ export default function App() { - Create React App example with styled-components and TypeScript + Material UI Create React App example with styled-components in TypeScript diff --git a/examples/create-react-app-with-typescript/src/ProTip.tsx b/examples/material-cra-styled-components-ts/src/ProTip.tsx similarity index 96% rename from examples/create-react-app-with-typescript/src/ProTip.tsx rename to examples/material-cra-styled-components-ts/src/ProTip.tsx index 5a8b457f024fbd..0894a06eb94bde 100644 --- a/examples/create-react-app-with-typescript/src/ProTip.tsx +++ b/examples/material-cra-styled-components-ts/src/ProTip.tsx @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/create-react-app-with-styled-components-typescript/src/index.tsx b/examples/material-cra-styled-components-ts/src/index.tsx similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/src/index.tsx rename to examples/material-cra-styled-components-ts/src/index.tsx diff --git a/examples/joy-cra-typescript/src/react-app-env.d.ts b/examples/material-cra-styled-components-ts/src/react-app-env.d.ts similarity index 100% rename from examples/joy-cra-typescript/src/react-app-env.d.ts rename to examples/material-cra-styled-components-ts/src/react-app-env.d.ts diff --git a/examples/create-react-app-with-styled-components-typescript/src/setupTests.ts b/examples/material-cra-styled-components-ts/src/setupTests.ts similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/src/setupTests.ts rename to examples/material-cra-styled-components-ts/src/setupTests.ts diff --git a/examples/create-react-app-with-styled-components-typescript/tsconfig.json b/examples/material-cra-styled-components-ts/tsconfig.json similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/tsconfig.json rename to examples/material-cra-styled-components-ts/tsconfig.json diff --git a/examples/create-react-app-with-styled-components-typescript/tsconfig.paths.json b/examples/material-cra-styled-components-ts/tsconfig.paths.json similarity index 100% rename from examples/create-react-app-with-styled-components-typescript/tsconfig.paths.json rename to examples/material-cra-styled-components-ts/tsconfig.paths.json diff --git a/examples/mui-base-with-tailwind-css/.gitignore b/examples/material-cra-styled-components/.gitignore similarity index 100% rename from examples/mui-base-with-tailwind-css/.gitignore rename to examples/material-cra-styled-components/.gitignore diff --git a/examples/create-react-app-with-styled-components/README.md b/examples/material-cra-styled-components/README.md similarity index 82% rename from examples/create-react-app-with-styled-components/README.md rename to examples/material-cra-styled-components/README.md index 2922d22048c8ad..405d2ba066dfb3 100644 --- a/examples/create-react-app-with-styled-components/README.md +++ b/examples/material-cra-styled-components/README.md @@ -1,4 +1,4 @@ -# Create React App example with styled-components +# Material UI - Create React App example with styled-components ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-styled-components -cd create-react-app-with-styled-components +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-cra-styled-components +cd material-cra-styled-components ``` Install it and run: @@ -22,7 +22,7 @@ npm start -Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-styled-components). +Note that CodeSandbox is not supporting react-app-rewired, yet you can [still see the code](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/material-cra-styled-components). The following link leverages this demo: https://mui.com/guides/interoperability/#change-the-default-styled-engine with Parcel's alias feature within the `package.json` diff --git a/examples/create-react-app-with-styled-components/craco.config.js b/examples/material-cra-styled-components/craco.config.js similarity index 100% rename from examples/create-react-app-with-styled-components/craco.config.js rename to examples/material-cra-styled-components/craco.config.js diff --git a/examples/create-react-app-with-styled-components/package.json b/examples/material-cra-styled-components/package.json similarity index 93% rename from examples/create-react-app-with-styled-components/package.json rename to examples/material-cra-styled-components/package.json index 1c31953f3b6658..c68e8530980712 100644 --- a/examples/create-react-app-with-styled-components/package.json +++ b/examples/material-cra-styled-components/package.json @@ -1,5 +1,5 @@ { - "name": "create-react-app-with-styled-components", + "name": "material-cra-styled-components", "version": "5.0.0", "private": true, "dependencies": { @@ -35,4 +35,4 @@ "devDependencies": { "@craco/craco": "latest" } -} +} \ No newline at end of file diff --git a/examples/create-react-app-with-styled-components/public/favicon.ico b/examples/material-cra-styled-components/public/favicon.ico similarity index 100% rename from examples/create-react-app-with-styled-components/public/favicon.ico rename to examples/material-cra-styled-components/public/favicon.ico diff --git a/examples/create-react-app-with-styled-components/public/index.html b/examples/material-cra-styled-components/public/index.html similarity index 100% rename from examples/create-react-app-with-styled-components/public/index.html rename to examples/material-cra-styled-components/public/index.html diff --git a/examples/mui-base-with-tailwind-css/public/manifest.json b/examples/material-cra-styled-components/public/manifest.json similarity index 100% rename from examples/mui-base-with-tailwind-css/public/manifest.json rename to examples/material-cra-styled-components/public/manifest.json diff --git a/examples/mui-base-with-tailwind-css/public/robots.txt b/examples/material-cra-styled-components/public/robots.txt similarity index 100% rename from examples/mui-base-with-tailwind-css/public/robots.txt rename to examples/material-cra-styled-components/public/robots.txt diff --git a/examples/create-react-app-with-styled-components/src/App.js b/examples/material-cra-styled-components/src/App.js similarity index 91% rename from examples/create-react-app-with-styled-components/src/App.js rename to examples/material-cra-styled-components/src/App.js index c35dd204ffb1ff..945ab576549aa7 100644 --- a/examples/create-react-app-with-styled-components/src/App.js +++ b/examples/material-cra-styled-components/src/App.js @@ -22,7 +22,7 @@ export default function App() { - Create React App example with styled-components + Material UI Create React App example with styled-components diff --git a/examples/gatsby/src/components/ProTip.js b/examples/material-cra-styled-components/src/ProTip.js similarity index 95% rename from examples/gatsby/src/components/ProTip.js rename to examples/material-cra-styled-components/src/ProTip.js index 6d81f33b0a0dad..09d7e4ae4ae35b 100644 --- a/examples/gatsby/src/components/ProTip.js +++ b/examples/material-cra-styled-components/src/ProTip.js @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/create-react-app-with-styled-components/src/index.js b/examples/material-cra-styled-components/src/index.js similarity index 100% rename from examples/create-react-app-with-styled-components/src/index.js rename to examples/material-cra-styled-components/src/index.js diff --git a/examples/create-react-app-with-styled-components/src/serviceWorker.js b/examples/material-cra-styled-components/src/serviceWorker.js similarity index 100% rename from examples/create-react-app-with-styled-components/src/serviceWorker.js rename to examples/material-cra-styled-components/src/serviceWorker.js diff --git a/examples/create-react-app-with-styled-components/src/setupTests.js b/examples/material-cra-styled-components/src/setupTests.js similarity index 100% rename from examples/create-react-app-with-styled-components/src/setupTests.js rename to examples/material-cra-styled-components/src/setupTests.js diff --git a/examples/tailwind-css/.gitignore b/examples/material-cra-tailwind-ts/.gitignore similarity index 100% rename from examples/tailwind-css/.gitignore rename to examples/material-cra-tailwind-ts/.gitignore diff --git a/examples/tailwind-css/README.md b/examples/material-cra-tailwind-ts/README.md similarity index 80% rename from examples/tailwind-css/README.md rename to examples/material-cra-tailwind-ts/README.md index 67e0952eab3ec4..86a809537f97c2 100644 --- a/examples/tailwind-css/README.md +++ b/examples/material-cra-tailwind-ts/README.md @@ -1,4 +1,4 @@ -# Tailwind CSS example +# Material UI - CRA example with Tailwind CSS in TypeScript ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/tailwind-css -cd tailwind-css +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-cra-tailwind-ts +cd material-cra-tailwind-ts ``` Install it and run: @@ -32,8 +32,8 @@ or: -This example demonstrates how you can use [Tailwind CSS](https://tailwindcss.com/) and [Create React App](https://github.com/facebookincubator/create-react-app) together with MUI. -It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. +This example demonstrates how you can use [Tailwind CSS](https://tailwindcss.com/) and [Create React App](https://github.com/facebookincubator/create-react-app) together with Material UI. +It includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. ## What's next? diff --git a/examples/tailwind-css/package.json b/examples/material-cra-tailwind-ts/package.json similarity index 96% rename from examples/tailwind-css/package.json rename to examples/material-cra-tailwind-ts/package.json index 52ac6c2fe70d2c..6ba75f6360e164 100644 --- a/examples/tailwind-css/package.json +++ b/examples/material-cra-tailwind-ts/package.json @@ -1,5 +1,5 @@ { - "name": "tailwind-css", + "name": "material-cra-tailwind-ts", "version": "5.0.0", "private": true, "dependencies": { @@ -40,4 +40,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/tailwind-css/postcss.config.js b/examples/material-cra-tailwind-ts/postcss.config.js similarity index 100% rename from examples/tailwind-css/postcss.config.js rename to examples/material-cra-tailwind-ts/postcss.config.js diff --git a/examples/joy-cra-typescript/public/favicon.ico b/examples/material-cra-tailwind-ts/public/favicon.ico similarity index 100% rename from examples/joy-cra-typescript/public/favicon.ico rename to examples/material-cra-tailwind-ts/public/favicon.ico diff --git a/examples/tailwind-css/public/index.html b/examples/material-cra-tailwind-ts/public/index.html similarity index 100% rename from examples/tailwind-css/public/index.html rename to examples/material-cra-tailwind-ts/public/index.html diff --git a/examples/tailwind-css/public/logo192.png b/examples/material-cra-tailwind-ts/public/logo192.png similarity index 100% rename from examples/tailwind-css/public/logo192.png rename to examples/material-cra-tailwind-ts/public/logo192.png diff --git a/examples/tailwind-css/public/logo512.png b/examples/material-cra-tailwind-ts/public/logo512.png similarity index 100% rename from examples/tailwind-css/public/logo512.png rename to examples/material-cra-tailwind-ts/public/logo512.png diff --git a/examples/preact/public/manifest.json b/examples/material-cra-tailwind-ts/public/manifest.json similarity index 100% rename from examples/preact/public/manifest.json rename to examples/material-cra-tailwind-ts/public/manifest.json diff --git a/examples/preact/public/robots.txt b/examples/material-cra-tailwind-ts/public/robots.txt similarity index 100% rename from examples/preact/public/robots.txt rename to examples/material-cra-tailwind-ts/public/robots.txt diff --git a/examples/tailwind-css/src/App.tsx b/examples/material-cra-tailwind-ts/src/App.tsx similarity index 93% rename from examples/tailwind-css/src/App.tsx rename to examples/material-cra-tailwind-ts/src/App.tsx index 5c23b947e37c2e..5c9a0da97f290e 100644 --- a/examples/tailwind-css/src/App.tsx +++ b/examples/material-cra-tailwind-ts/src/App.tsx @@ -24,7 +24,7 @@ export default function App() {
- Create React App + Tailwind CSS example + Material UI Create React App example with Tailwind CSS in TypeScript - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/tailwind-css/src/index.css b/examples/material-cra-tailwind-ts/src/index.css similarity index 100% rename from examples/tailwind-css/src/index.css rename to examples/material-cra-tailwind-ts/src/index.css diff --git a/examples/tailwind-css/src/index.tsx b/examples/material-cra-tailwind-ts/src/index.tsx similarity index 100% rename from examples/tailwind-css/src/index.tsx rename to examples/material-cra-tailwind-ts/src/index.tsx diff --git a/examples/tailwind-css/src/logo.svg b/examples/material-cra-tailwind-ts/src/logo.svg similarity index 100% rename from examples/tailwind-css/src/logo.svg rename to examples/material-cra-tailwind-ts/src/logo.svg diff --git a/examples/mui-base-with-tailwind-css/src/react-app-env.d.ts b/examples/material-cra-tailwind-ts/src/react-app-env.d.ts similarity index 100% rename from examples/mui-base-with-tailwind-css/src/react-app-env.d.ts rename to examples/material-cra-tailwind-ts/src/react-app-env.d.ts diff --git a/examples/tailwind-css/src/reportWebVitals.ts b/examples/material-cra-tailwind-ts/src/reportWebVitals.ts similarity index 100% rename from examples/tailwind-css/src/reportWebVitals.ts rename to examples/material-cra-tailwind-ts/src/reportWebVitals.ts diff --git a/examples/tailwind-css/src/setupTests.ts b/examples/material-cra-tailwind-ts/src/setupTests.ts similarity index 100% rename from examples/tailwind-css/src/setupTests.ts rename to examples/material-cra-tailwind-ts/src/setupTests.ts diff --git a/examples/tailwind-css/tailwind.config.js b/examples/material-cra-tailwind-ts/tailwind.config.js similarity index 62% rename from examples/tailwind-css/tailwind.config.js rename to examples/material-cra-tailwind-ts/tailwind.config.js index 4638b2a57bc5c2..cd7eea145090e1 100644 --- a/examples/tailwind-css/tailwind.config.js +++ b/examples/material-cra-tailwind-ts/tailwind.config.js @@ -5,7 +5,7 @@ module.exports = { extend: {}, }, corePlugins: { - // Remove Tailwind CSS's preflight style so it can use the MUI's preflight instead (CssBaseline). + // Remove the Tailwind CSS preflight styles so it can use Material UI's preflight instead (CssBaseline). preflight: false, }, plugins: [], diff --git a/examples/tailwind-css/tsconfig.json b/examples/material-cra-tailwind-ts/tsconfig.json similarity index 100% rename from examples/tailwind-css/tsconfig.json rename to examples/material-cra-tailwind-ts/tsconfig.json diff --git a/examples/create-react-app/.gitignore b/examples/material-cra-ts/.gitignore similarity index 100% rename from examples/create-react-app/.gitignore rename to examples/material-cra-ts/.gitignore diff --git a/examples/create-react-app-with-typescript/README.md b/examples/material-cra-ts/README.md similarity index 67% rename from examples/create-react-app-with-typescript/README.md rename to examples/material-cra-ts/README.md index 0efedf4d57ec20..f505dd1f40fbe8 100644 --- a/examples/create-react-app-with-typescript/README.md +++ b/examples/material-cra-ts/README.md @@ -1,4 +1,4 @@ -# Create React App example with TypeScript +# Material UI - Create React App example in TypeScript ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app-with-typescript -cd create-react-app-with-typescript +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-cra-ts +cd material-cra-ts ``` Install it and run: @@ -22,16 +22,16 @@ or: -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/material-cra-ts) -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/create-react-app-with-typescript) +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/material-cra-ts) ## The idea behind the example -This example demonstrates how you can use [Create React App](https://github.com/facebookincubator/create-react-app) with [TypeScript](https://github.com/Microsoft/TypeScript). -It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. +This example demonstrates how you can use Material UI with [Create React App](https://github.com/facebookincubator/create-react-app) in [TypeScript](https://github.com/Microsoft/TypeScript). +It includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). ## What's next? diff --git a/examples/create-react-app-with-typescript/package.json b/examples/material-cra-ts/package.json similarity index 93% rename from examples/create-react-app-with-typescript/package.json rename to examples/material-cra-ts/package.json index 0c273d70af0e81..2e064160a99c31 100644 --- a/examples/create-react-app-with-typescript/package.json +++ b/examples/material-cra-ts/package.json @@ -1,5 +1,5 @@ { - "name": "create-react-app-with-typescript", + "name": "material-cra-ts", "version": "5.0.0", "private": true, "dependencies": { @@ -31,4 +31,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/mui-base-with-tailwind-css/public/favicon.ico b/examples/material-cra-ts/public/favicon.ico similarity index 100% rename from examples/mui-base-with-tailwind-css/public/favicon.ico rename to examples/material-cra-ts/public/favicon.ico diff --git a/examples/create-react-app/public/index.html b/examples/material-cra-ts/public/index.html similarity index 100% rename from examples/create-react-app/public/index.html rename to examples/material-cra-ts/public/index.html diff --git a/examples/create-react-app/public/manifest.json b/examples/material-cra-ts/public/manifest.json similarity index 100% rename from examples/create-react-app/public/manifest.json rename to examples/material-cra-ts/public/manifest.json diff --git a/examples/create-react-app-with-typescript/src/App.tsx b/examples/material-cra-ts/src/App.tsx similarity index 92% rename from examples/create-react-app-with-typescript/src/App.tsx rename to examples/material-cra-ts/src/App.tsx index 23e63d706fd76f..943ee8503a08ff 100644 --- a/examples/create-react-app-with-typescript/src/App.tsx +++ b/examples/material-cra-ts/src/App.tsx @@ -22,7 +22,7 @@ export default function App() { - Create React App example with TypeScript + Material UI Create React App example in TypeScript diff --git a/examples/remix-with-typescript/app/src/ProTip.tsx b/examples/material-cra-ts/src/ProTip.tsx similarity index 96% rename from examples/remix-with-typescript/app/src/ProTip.tsx rename to examples/material-cra-ts/src/ProTip.tsx index 5a8b457f024fbd..0894a06eb94bde 100644 --- a/examples/remix-with-typescript/app/src/ProTip.tsx +++ b/examples/material-cra-ts/src/ProTip.tsx @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/create-react-app-with-typescript/src/index.tsx b/examples/material-cra-ts/src/index.tsx similarity index 100% rename from examples/create-react-app-with-typescript/src/index.tsx rename to examples/material-cra-ts/src/index.tsx diff --git a/examples/tailwind-css/src/react-app-env.d.ts b/examples/material-cra-ts/src/react-app-env.d.ts similarity index 100% rename from examples/tailwind-css/src/react-app-env.d.ts rename to examples/material-cra-ts/src/react-app-env.d.ts diff --git a/examples/create-react-app-with-typescript/src/theme.ts b/examples/material-cra-ts/src/theme.ts similarity index 100% rename from examples/create-react-app-with-typescript/src/theme.ts rename to examples/material-cra-ts/src/theme.ts diff --git a/examples/joy-cra-typescript/tsconfig.json b/examples/material-cra-ts/tsconfig.json similarity index 100% rename from examples/joy-cra-typescript/tsconfig.json rename to examples/material-cra-ts/tsconfig.json diff --git a/examples/joy-cra-typescript/.gitignore b/examples/material-cra/.gitignore similarity index 100% rename from examples/joy-cra-typescript/.gitignore rename to examples/material-cra/.gitignore diff --git a/examples/create-react-app/README.md b/examples/material-cra/README.md similarity index 78% rename from examples/create-react-app/README.md rename to examples/material-cra/README.md index c7c2c1384915e8..8ed9da6c9aa578 100644 --- a/examples/create-react-app/README.md +++ b/examples/material-cra/README.md @@ -1,4 +1,4 @@ -# Create React App example +# Material UI - Create React App example ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/create-react-app -cd create-react-app +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-cra +cd material-cra ``` Install it and run: @@ -22,18 +22,18 @@ or: -[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/create-react-app) +[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/mui/material-ui/tree/master/examples/material-cra) -[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/create-react-app) +[![Edit on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mui/material-ui/tree/master/examples/material-cra) ## The idea behind the example -This example demonstrates how you can use [Create React App](https://github.com/facebookincubator/create-react-app). -It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. +This example demonstrates how you can use [Create React App](https://github.com/facebookincubator/create-react-app) with Material UI. +It includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). ## What's next? diff --git a/examples/create-react-app/package.json b/examples/material-cra/package.json similarity index 95% rename from examples/create-react-app/package.json rename to examples/material-cra/package.json index e24b716559e482..de4ba7fa4656e3 100644 --- a/examples/create-react-app/package.json +++ b/examples/material-cra/package.json @@ -1,5 +1,5 @@ { - "name": "create-react-app", + "name": "material-cra", "version": "5.0.0", "private": true, "scripts": { @@ -28,4 +28,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/examples/tailwind-css/public/favicon.ico b/examples/material-cra/public/favicon.ico similarity index 100% rename from examples/tailwind-css/public/favicon.ico rename to examples/material-cra/public/favicon.ico diff --git a/examples/joy-cra-typescript/public/index.html b/examples/material-cra/public/index.html similarity index 100% rename from examples/joy-cra-typescript/public/index.html rename to examples/material-cra/public/index.html diff --git a/examples/joy-cra-typescript/public/manifest.json b/examples/material-cra/public/manifest.json similarity index 100% rename from examples/joy-cra-typescript/public/manifest.json rename to examples/material-cra/public/manifest.json diff --git a/examples/create-react-app/src/App.js b/examples/material-cra/src/App.js similarity index 94% rename from examples/create-react-app/src/App.js rename to examples/material-cra/src/App.js index f58653fc24ea3b..9cc31cf62c4da2 100644 --- a/examples/create-react-app/src/App.js +++ b/examples/material-cra/src/App.js @@ -23,7 +23,7 @@ export default function App() { - Create React App example + Material UI Create React App example diff --git a/examples/create-react-app-with-styled-components/src/ProTip.js b/examples/material-cra/src/ProTip.js similarity index 95% rename from examples/create-react-app-with-styled-components/src/ProTip.js rename to examples/material-cra/src/ProTip.js index 6d81f33b0a0dad..09d7e4ae4ae35b 100644 --- a/examples/create-react-app-with-styled-components/src/ProTip.js +++ b/examples/material-cra/src/ProTip.js @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/create-react-app/src/index.js b/examples/material-cra/src/index.js similarity index 100% rename from examples/create-react-app/src/index.js rename to examples/material-cra/src/index.js diff --git a/examples/create-react-app/src/theme.js b/examples/material-cra/src/theme.js similarity index 100% rename from examples/create-react-app/src/theme.js rename to examples/material-cra/src/theme.js diff --git a/examples/ssr/.babelrc b/examples/material-express-ssr/.babelrc similarity index 100% rename from examples/ssr/.babelrc rename to examples/material-express-ssr/.babelrc diff --git a/examples/ssr/.gitignore b/examples/material-express-ssr/.gitignore similarity index 100% rename from examples/ssr/.gitignore rename to examples/material-express-ssr/.gitignore diff --git a/examples/ssr/App.js b/examples/material-express-ssr/App.js similarity index 93% rename from examples/ssr/App.js rename to examples/material-express-ssr/App.js index 28ae1d65c93952..a695eb4e4edc97 100644 --- a/examples/ssr/App.js +++ b/examples/material-express-ssr/App.js @@ -23,7 +23,7 @@ export default function App() { - Server-side rendering example + Material UI Express.js server-rendered example diff --git a/examples/create-react-app/src/ProTip.js b/examples/material-express-ssr/ProTip.js similarity index 95% rename from examples/create-react-app/src/ProTip.js rename to examples/material-express-ssr/ProTip.js index 6d81f33b0a0dad..09d7e4ae4ae35b 100644 --- a/examples/create-react-app/src/ProTip.js +++ b/examples/material-express-ssr/ProTip.js @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/ssr/README.md b/examples/material-express-ssr/README.md similarity index 80% rename from examples/ssr/README.md rename to examples/material-express-ssr/README.md index 7ea97edaba324b..f85a729a3c16fe 100644 --- a/examples/ssr/README.md +++ b/examples/material-express-ssr/README.md @@ -1,4 +1,4 @@ -# Server-side rendering example +# Material UI - Server-side-rendered example ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/ssr -cd ssr +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-express-ssr +cd material-express-ssr ``` Install it and run: @@ -22,7 +22,7 @@ npm run start This is the reference implementation of the [Server Rendering tutorial](https://mui.com/material-ui/guides/server-rendering/). -The example project includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. +The example project includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). ## What's next? diff --git a/examples/ssr/client.js b/examples/material-express-ssr/client.js similarity index 100% rename from examples/ssr/client.js rename to examples/material-express-ssr/client.js diff --git a/examples/ssr/createEmotionCache.js b/examples/material-express-ssr/createEmotionCache.js similarity index 74% rename from examples/ssr/createEmotionCache.js rename to examples/material-express-ssr/createEmotionCache.js index a1f11107d2ed06..b83cd1166c8c4b 100644 --- a/examples/ssr/createEmotionCache.js +++ b/examples/material-express-ssr/createEmotionCache.js @@ -3,8 +3,8 @@ import createCache from '@emotion/cache'; const isBrowser = typeof document !== 'undefined'; // On the client side, Create a meta tag at the top of the and set it as insertionPoint. -// This assures that MUI styles are loaded first. -// It allows developers to easily override MUI styles with other styling solutions, like CSS modules. +// This assures that Material UI styles are loaded first. +// It allows developers to easily override Material UI styles with other styling solutions, like CSS modules. export default function createEmotionCache() { let insertionPoint; diff --git a/examples/ssr/package.json b/examples/material-express-ssr/package.json similarity index 96% rename from examples/ssr/package.json rename to examples/material-express-ssr/package.json index 1bae81d90809d7..823ea805e86150 100644 --- a/examples/ssr/package.json +++ b/examples/material-express-ssr/package.json @@ -1,5 +1,5 @@ { - "name": "ssr", + "name": "material-express-ssr", "version": "5.0.0", "private": true, "browserslist": [ @@ -34,4 +34,4 @@ "production": "cross-env NODE_ENV=production npm start", "post-update": "echo \"codesandbox preview only, need an update\" && yarn upgrade --latest" } -} +} \ No newline at end of file diff --git a/examples/ssr/server.js b/examples/material-express-ssr/server.js similarity index 100% rename from examples/ssr/server.js rename to examples/material-express-ssr/server.js diff --git a/examples/preact/src/theme.js b/examples/material-express-ssr/theme.js similarity index 100% rename from examples/preact/src/theme.js rename to examples/material-express-ssr/theme.js diff --git a/examples/ssr/webpack.config.js b/examples/material-express-ssr/webpack.config.js similarity index 100% rename from examples/ssr/webpack.config.js rename to examples/material-express-ssr/webpack.config.js diff --git a/examples/gatsby/.gitignore b/examples/material-gatsby/.gitignore similarity index 100% rename from examples/gatsby/.gitignore rename to examples/material-gatsby/.gitignore diff --git a/examples/gatsby/README.md b/examples/material-gatsby/README.md similarity index 83% rename from examples/gatsby/README.md rename to examples/material-gatsby/README.md index 8790cb1ef447a0..a29753def4e05b 100644 --- a/examples/gatsby/README.md +++ b/examples/material-gatsby/README.md @@ -1,4 +1,4 @@ -# Gatsby example +# Material UI - Gatsby example ## How to use @@ -7,8 +7,8 @@ Download the example [or clone the repo](https://github.com/mui/material-ui): ```sh -curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/gatsby -cd gatsby +curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/material-gatsby +cd material-gatsby ``` Install it and run: @@ -21,7 +21,7 @@ npm run develop ## The idea behind the example The project uses [Gatsby](https://github.com/gatsbyjs/gatsby), which is a static site generator for React. -It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in MUI v5. +It includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). ## What's next? diff --git a/examples/gatsby/package.json b/examples/material-gatsby/package.json similarity index 95% rename from examples/gatsby/package.json rename to examples/material-gatsby/package.json index 48abc3f50f4ea4..efedfe033dccb8 100644 --- a/examples/gatsby/package.json +++ b/examples/material-gatsby/package.json @@ -1,5 +1,5 @@ { - "name": "gatsby", + "name": "material-gatsby", "version": "5.0.0", "private": true, "browserslist": [ @@ -23,4 +23,4 @@ "serve": "gatsby serve", "post-update": "echo \"codesandbox preview only, need an update\" && yarn upgrade --latest" } -} +} \ No newline at end of file diff --git a/examples/gatsby/src/components/Copyright.js b/examples/material-gatsby/src/components/Copyright.js similarity index 100% rename from examples/gatsby/src/components/Copyright.js rename to examples/material-gatsby/src/components/Copyright.js diff --git a/examples/gatsby/src/components/Link.js b/examples/material-gatsby/src/components/Link.js similarity index 100% rename from examples/gatsby/src/components/Link.js rename to examples/material-gatsby/src/components/Link.js diff --git a/examples/nextjs/src/ProTip.js b/examples/material-gatsby/src/components/ProTip.js similarity index 95% rename from examples/nextjs/src/ProTip.js rename to examples/material-gatsby/src/components/ProTip.js index 6d81f33b0a0dad..09d7e4ae4ae35b 100644 --- a/examples/nextjs/src/ProTip.js +++ b/examples/material-gatsby/src/components/ProTip.js @@ -15,7 +15,7 @@ export default function ProTip() { return ( - Pro tip: See more templates on + Pro tip: See more templates in the MUI documentation. ); diff --git a/examples/gatsby/src/pages/about.js b/examples/material-gatsby/src/pages/about.js similarity index 94% rename from examples/gatsby/src/pages/about.js rename to examples/material-gatsby/src/pages/about.js index 19c0cae66dd273..3368f279e41327 100644 --- a/examples/gatsby/src/pages/about.js +++ b/examples/material-gatsby/src/pages/about.js @@ -11,7 +11,7 @@ export default function About() { - Gatsby example + Material UI Gatsby example Go to the main page diff --git a/examples/gatsby/src/pages/index.js b/examples/material-gatsby/src/pages/index.js similarity index 94% rename from examples/gatsby/src/pages/index.js rename to examples/material-gatsby/src/pages/index.js index 10bba6bebe8f91..17ecbb53d2d085 100644 --- a/examples/gatsby/src/pages/index.js +++ b/examples/material-gatsby/src/pages/index.js @@ -11,7 +11,7 @@ export default function Index() { - Gatsby example + Material UI Gatsby example Go to the about page diff --git a/examples/gatsby/src/theme.js b/examples/material-gatsby/src/theme.js similarity index 100% rename from examples/gatsby/src/theme.js rename to examples/material-gatsby/src/theme.js diff --git a/examples/nextjs-with-typescript-v4-migration/.gitignore b/examples/material-next-ts-v4-v5-migration/.gitignore similarity index 100% rename from examples/nextjs-with-typescript-v4-migration/.gitignore rename to examples/material-next-ts-v4-v5-migration/.gitignore diff --git a/examples/nextjs-with-typescript-v4-migration/README.md b/examples/material-next-ts-v4-v5-migration/README.md similarity index 91% rename from examples/nextjs-with-typescript-v4-migration/README.md rename to examples/material-next-ts-v4-v5-migration/README.md index f453b64decf861..cc84e2fd1add93 100644 --- a/examples/nextjs-with-typescript-v4-migration/README.md +++ b/examples/material-next-ts-v4-v5-migration/README.md @@ -29,7 +29,7 @@ or: ## The idea behind the example The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps. -It includes `@mui/material` and its peer dependencies, including `emotion`, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). +It includes `@mui/material` and its peer dependencies, including Emotion, the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://mui.com/material-ui/guides/interoperability/#styled-components). It also includes `@mui/styles`, the legacy styling solution that uses JSS as an engine. It provides all the necessary config for working with both Emotion and JSS for server-side rendering. The project is intended as a basic starter for migrating your application from v4 to v5, as it lets the JSS style overrides take precedence over the default styles passed to the components by Emotion. diff --git a/examples/nextjs-with-typescript-v4-migration/next.config.js b/examples/material-next-ts-v4-v5-migration/next.config.js similarity index 100% rename from examples/nextjs-with-typescript-v4-migration/next.config.js rename to examples/material-next-ts-v4-v5-migration/next.config.js diff --git a/examples/nextjs-with-typescript-v4-migration/package.json b/examples/material-next-ts-v4-v5-migration/package.json similarity index 93% rename from examples/nextjs-with-typescript-v4-migration/package.json rename to examples/material-next-ts-v4-v5-migration/package.json index c3f640c8532643..8a6fb8eac2ef12 100644 --- a/examples/nextjs-with-typescript-v4-migration/package.json +++ b/examples/material-next-ts-v4-v5-migration/package.json @@ -1,5 +1,5 @@ { - "name": "nextjs-with-typescript-with-mui-styles", + "name": "material-next-ts-v4-v5-migration", "version": "5.0.0", "private": true, "scripts": { @@ -31,4 +31,4 @@ "eslint-config-next": "latest", "typescript": "latest" } -} +} \ No newline at end of file diff --git a/examples/nextjs-with-typescript-v4-migration/pages/_app.tsx b/examples/material-next-ts-v4-v5-migration/pages/_app.tsx similarity index 100% rename from examples/nextjs-with-typescript-v4-migration/pages/_app.tsx rename to examples/material-next-ts-v4-v5-migration/pages/_app.tsx diff --git a/examples/nextjs-with-typescript-v4-migration/pages/_document.tsx b/examples/material-next-ts-v4-v5-migration/pages/_document.tsx similarity index 100% rename from examples/nextjs-with-typescript-v4-migration/pages/_document.tsx rename to examples/material-next-ts-v4-v5-migration/pages/_document.tsx diff --git a/examples/nextjs-with-typescript-v4-migration/pages/about.tsx b/examples/material-next-ts-v4-v5-migration/pages/about.tsx similarity index 93% rename from examples/nextjs-with-typescript-v4-migration/pages/about.tsx rename to examples/material-next-ts-v4-v5-migration/pages/about.tsx index 1a96c14f7f77fd..82fed281f7e49f 100644 --- a/examples/nextjs-with-typescript-v4-migration/pages/about.tsx +++ b/examples/material-next-ts-v4-v5-migration/pages/about.tsx @@ -25,7 +25,7 @@ export default function About() {
- MUI v5 + Next.js with TypeScript example + Material UI - Next.js example in TypeScript with legacy @mui/styles