Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Fix /base-ui redirect and prune links #45083

Merged
merged 9 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/data/joy/components/accordion/accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React Accordion component
components: Accordion, AccordionDetails, AccordionGroup, AccordionSummary
githubLabel: 'component: accordion'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/accordion/
unstyled: https://base-ui.com/react/components/accordion
Copy link
Member Author

@mj12albert mj12albert Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Joy UI docs, I've added the corresponding (new) Base UI page when applicable
e.g. https://deploy-preview-45084--material-ui.netlify.app/joy-ui/react-accordion/#unstyled

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good shout

---

# Accordion
Expand Down
1 change: 0 additions & 1 deletion docs/data/joy/components/badge/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ productId: joy-ui
title: React Badge component
components: Badge
githubLabel: 'component: badge'
unstyled: /base-ui/react-badge/
---

# Badge
Expand Down
1 change: 0 additions & 1 deletion docs/data/joy/components/button/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ title: React Button component
components: Button, IconButton
githubLabel: 'component: button'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/
unstyled: /base-ui/react-button/
---

# Button
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React Checkbox component
components: Checkbox
githubLabel: 'component: checkbox'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
unstyled: https://base-ui.com/react/components/checkbox
---

# Checkbox
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/divider/divider.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ productId: joy-ui
title: React Divider component
components: Divider
githubLabel: 'component: divider'
unstyled: https://base-ui.com/react/components/separator
---

# Divider
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/input/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
productId: joy-ui
title: React Input component
components: FormControl, FormHelperText, FormLabel, Input
unstyled: /base-ui/react-input/
unstyled: https://base-ui.com/react/components/input
---

# Input
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/menu/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: React Menu component
components: Menu, MenuItem, MenuList, MenuButton
githubLabel: 'component: menu'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
unstyled: /base-ui/react-menu/
unstyled: https://base-ui.com/react/components/menu
---

# Menu
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/modal/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React Modal component
components: Modal, ModalClose, ModalDialog, ModalOverflow, DialogTitle, DialogContent, DialogActions
githubLabel: 'component: modal'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/
unstyled: https://base-ui.com/react/components/dialog
---

# Modal
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/radio-button/radio-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React Radio Button component
components: Radio, RadioGroup
githubLabel: 'component: radio'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
unstyled: https://base-ui.com/react/components/radio
---

# Radio
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/select/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: React Select component
components: Select, Option
githubLabel: 'component: select'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/
unstyled: /base-ui/react-select/
unstyled: https://base-ui.com/react/components/select
---

# Select
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/slider/slider.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ productId: joy-ui
title: React Slider component
components: Slider
githubLabel: 'component: slider'
unstyled: /base-ui/react-slider/
unstyled: https://base-ui.com/react/components/slider
---

# Slider
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/switch/switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ productId: joy-ui
title: React Switch component
components: Switch
githubLabel: 'component: switch'
unstyled: /base-ui/react-switch/
unstyled: https://base-ui.com/react/components/switch
---

# Switch
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/tabs/tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: React Tabs component
components: Tab, TabList, TabPanel, Tabs
githubLabel: 'component: tabs'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/tabs/
unstyled: /base-ui/react-tabs/
unstyled: https://base-ui.com/react/components/menu
---

# Tabs
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/text-field/text-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
productId: joy-ui
title: React Text Field component
githubLabel: 'component: text field'
unstyled: https://base-ui.com/react/components/field
---

# Text Field
Expand Down
1 change: 0 additions & 1 deletion docs/data/joy/components/textarea/textarea.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ productId: joy-ui
title: React Textarea component
components: Textarea
githubLabel: 'component: TextareaAutosize'
unstyled: /base-ui/react-textarea-autosize/
---

# Textarea
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ productId: joy-ui
title: React Toggle Button Group component
githubLabel: 'component: toggle button'
components: ToggleButtonGroup, Button, IconButton
unstyled: https://base-ui.com/react/components/toggle-group
---

# Toggle Button Group
Expand Down
1 change: 1 addition & 0 deletions docs/data/joy/components/tooltip/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: React Tooltip component
components: Tooltip
githubLabel: 'component: tooltip'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/
unstyled: https://base-ui.com/react/components/tooltip
---

# Tooltip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: ClickAwayListener'
:::warning
Please refer to the [Click-Away Listener](/base-ui/react-click-away-listener/) component page in the MUI Base docs for demos and details on usage.

Click-Away Listener is a part of the standalone [MUI Base](/base-ui/) component library.
Click-Away Listener is a part of the standalone MUI Base component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version after MUI Base gets a stable release.
:::
2 changes: 1 addition & 1 deletion docs/data/material/components/no-ssr/no-ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ components: NoSsr
:::warning
Please refer to the [No-SSR](/base-ui/react-no-ssr/) component page in the MUI Base docs for demos and details on usage.

No-SSR is a part of the standalone [MUI Base](/base-ui/) component library.
No-SSR is a part of the standalone MUI Base component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version after MUI Base gets a stable release.
:::
2 changes: 1 addition & 1 deletion docs/data/material/components/portal/portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: Portal'
:::warning
Please refer to the [Portal](/base-ui/react-portal/) component page in the MUI Base docs for demos and details on usage.

Portal is a part of the standalone [MUI Base](/base-ui/) component library.
Portal is a part of the standalone MUI Base component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version after MUI Base gets a stable release.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: TextareaAutosize'
:::warning
Please refer to the [Textarea Autosize](/base-ui/react-textarea-autosize/) component page in the MUI Base docs for demos and details on usage.

Textarea Autosize is a part of the standalone [MUI Base](/base-ui/) component library.
Textarea Autosize is a part of the standalone MUI Base component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version after MUI Base gets a stable release.
:::
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/293

### Material UI vs. MUI Base

Material UI and [MUI Base](/base-ui/) feature many of the same UI components, but MUI Base comes without any default styles or styling solutions.
Material UI and MUI Base feature many of the same UI components, but MUI Base comes without any default styles or styling solutions.

Material UI is _comprehensive_ in that it comes packaged with default styles, and is optimized to work with [Emotion](https://emotion.sh/docs/introduction) (or [styled-components](https://styled-components.com/)).

Expand Down
4 changes: 2 additions & 2 deletions docs/data/system/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

MUI System is a set of CSS utilities to help you build custom designs more efficiently.
It's used internally by libraries like [Material UI](/material-ui/), [Joy UI](/joy-ui/getting-started/).
It can also be used to style [MUI Base](/base-ui/) components.
It can also be used to style MUI Base components.

MUI System gives you a set of flexible, generic wrapper components like [`Box`](/system/react-box/) and [`Container`](/system/react-container/) that can be quickly customized using the `sx` prop.
This prop lets you define styles directly within the components themselves, rather than creating bulky and redundant `const` definitions with styled-components.
Expand All @@ -26,7 +26,7 @@

## MUI System vs. MUI Base

[MUI Base](/base-ui/) is a library of "unstyled" React components, while MUI System is a set of utilities for quickly applying styles to those components (as well as our other component libraries like Material UI and Joy UI).
MUI Base is a library of "unstyled" React components, while MUI System is a set of utilities for quickly applying styles to those components (as well as our other component libraries like Material UI and Joy UI).

Check warning on line 29 in docs/data/system/getting-started/overview/overview.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'our'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/data/system/getting-started/overview/overview.md", "range": {"start": {"line": 29, "column": 154}}}, "severity": "WARNING"}

MUI Base is a standalone component library, whereas MUI System is _supplemental_ in that it's designed to be paired with MUI Base or any third-party components.
See the [Custom components page](/system/getting-started/custom-components/) for details on how to use MUI System.
9 changes: 9 additions & 0 deletions docs/next.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,15 @@ export default withDocsInfra({

return map;
},
redirects: async () => {
return [
{
source: '/base-ui/',
destination: 'https://base-ui.com',
permanent: true,
},
];
},
// Used to signal we run pnpm build
...(process.env.NODE_ENV === 'production'
? {
Expand Down
47 changes: 0 additions & 47 deletions docs/pages/base-ui.tsx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ https://v4.material-ui.com/* https://v4.mui.com/:splat 301!
/material-ui/experimental-api/css-theme-variables/overview/ /material-ui/customization/css-theme-variables/overview/ 301
/material-ui/experimental-api/css-theme-variables/usage/ /material-ui/customization/css-theme-variables/usage/ 301
/material-ui/experimental-api/css-theme-variables/customization/ /material-ui/customization/css-theme-variables/configuration/ 301
/base-ui https://base-ui.com 301
/base-ui/ https://base-ui.com/ 301

# Proxies

Expand Down
10 changes: 1 addition & 9 deletions docs/src/components/productCore/CoreProducts.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import Section from 'docs/src/layouts/Section';
import { InfoCard } from '@mui/docs/InfoCard';
import { Theme } from '@mui/material/styles';
import SvgMuiLogomark from 'docs/src/icons/SvgMuiLogomark';
import SvgBaseUiLogo from 'docs/src/icons/SvgBaseUiLogo';
import StyleRoundedIcon from '@mui/icons-material/StyleRounded';
import WebRoundedIcon from '@mui/icons-material/WebRounded';

Expand Down Expand Up @@ -35,13 +34,6 @@ const content = [
"An open-source React component library that implements MUI's own in-house design principles.",
link: '/joy-ui/getting-started/',
},
{
icon: <SvgBaseUiLogo width={14} height={14} sx={logoColor} />,
title: 'MUI Base',
description:
"A library of unstyled React components and low-level hooks. With MUI Base, you gain complete control over your app's CSS and accessibility features.",
link: '/base-ui/',
},
{
icon: <StyleRoundedIcon sx={iconStyles} />,
title: 'MUI System',
Expand All @@ -56,7 +48,7 @@ export default function CoreProducts() {
<Section cozy>
<Grid container spacing={2}>
{content.map(({ icon, title, description, link }) => (
<Grid key={title} size={{ xs: 12, md: 6 }}>
<Grid key={title} size={{ xs: 12, md: 4 }}>
<InfoCard
icon={icon}
link={link}
Expand Down
Loading