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][material-ui] Clarify RTL language support in localization guide #41784

Merged
merged 26 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c8dfeb0
[docs] Update the versions dropdown to show v6 (#41557)
mnajdova Mar 20, 2024
deb7a6d
[blog] Add post about remote (#41565)
danilo-leal Mar 20, 2024
6888897
[blog] Blog post with MUI X v7.0.0 annoucement (#41563) (#41604)
cherniavskii Mar 22, 2024
39fe215
[docs] Add notification for MUI X v7 blog post (#41587) (#41605)
cherniavskii Mar 22, 2024
bd8ced4
[website] Update pricing table (#41606)
cherniavskii Mar 22, 2024
e948fc7
[website] Add stray design adjustments throughout the site (#41642)
mnajdova Mar 25, 2024
b7f5def
[blog] Link to Romain's blog post in MUI X v7 announcement post (#41641)
cherniavskii Mar 25, 2024
cc8d22f
[material-ui][RadioGroup] Apply classnames (#41681)
ZeeshanTamboli Mar 27, 2024
5461733
[material-ui][docs] Fix typo in CSS theme variables customization (#4…
ZeeshanTamboli Mar 27, 2024
a8fe71a
[system] Fix typo to avoid infinite recursion in function call. (#41678)
ZeeshanTamboli Mar 27, 2024
602e68a
[core] Continue rename of Toolpad
oliviertassinari Mar 29, 2024
2da509f
[docs] Continue migration of Base UI to sperate repository
oliviertassinari Apr 1, 2024
807032d
[material-ui][docs] Remove deleted page from the sidenav (#41594)
danilo-leal Mar 22, 2024
fdc839b
[website] Add Aarón to About Us (#41747)
aarongarciah Apr 2, 2024
4170412
[docs-infra] Add Toolpad product/category IDs to types (#41551)
bharatkashyap Apr 3, 2024
42afab7
[material-ui][Autocomplete] Display options provided to the `options`…
ZeeshanTamboli Apr 4, 2024
cf08c2e
[docs][material-ui][Slider] Remove valueLabelFormat from restricted v…
ZeeshanTamboli Apr 4, 2024
5a07996
5.15.15 (#41752)
siriwatknp Apr 4, 2024
f188332
[base-ui][website] Page <title> should have no dots
oliviertassinari Apr 4, 2024
b3e95eb
[docs-infra] Fix analytics about inline ads (#41474)
alexfauquette Apr 5, 2024
24bc383
updated: Kurdish added as a RTL language
bahmanworld Apr 5, 2024
0455cbd
Merge branch 'next' into pr/41784
danilo-leal Apr 9, 2024
b1e4225
resolve conflict
ZeeshanTamboli Aug 26, 2024
e74eb9a
improve sentence
ZeeshanTamboli Aug 26, 2024
03c9779
revert unnecessary changes
ZeeshanTamboli Aug 26, 2024
9eef513
prettier
ZeeshanTamboli Aug 26, 2024
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
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# [Versions](https://mui.com/versions/)

## v5.15.15

<!-- generated comparing v5.15.14..master -->

_Apr 4, 2024_

A big thanks to the 7 contributors who made this release possible. Here are some highlights ✨:
This release was mostly about 🐛 bug fixes and 📚 documentation improvements.

### `@mui/material@5.15.15`

- [Autocomplete] Display options provided to the `options` prop even if loading is true (#41677) @ZeeshanTamboli
- [RadioGroup] Apply classnames (#41681) @ZeeshanTamboli

### `@mui/system@5.15.15`

- Fix typo to avoid infinite recursion in function call (#41678) @ZeeshanTamboli

### Docs

- [material-ui][Slider] Remove `valueLabelFormat` from restricted values demo so that the tooltip thumb label displays the same as the value text (#41679) @ZeeshanTamboli
- [material-ui] Remove deleted page from the sidenav (#41594) @danilo-leal
- [material-ui] Fix typo in CSS theme variables customization (#41680) @ZeeshanTamboli
- Continue migration of Base UI to sperate repository @oliviertassinari
- Add notification for MUI X v7 blog post (#41587) (#41605) @cherniavskii
- Update the versions dropdown to show v6 (#41557) @mnajdova

### Core

- [blog] Link to Romain's blog post in MUI X v7 announcement post (#41641) @cherniavskii
- [blog] Blog post with MUI X v7.0.0 annoucement (#41563) (#41604) @cherniavskii
- [blog] Add post about remote (#41565) @danilo-leal
- [core] Continue rename of Toolpad @oliviertassinari
- [docs-infra] Add Toolpad product/category IDs to types (#41551) @bharatkashyap
- [website] Add Aarón to About Us (#41747) @aarongarciah
- [website] Add stray design adjustments throughout the site (#41642) @mnajdova
- [website] Update pricing table (#41606) @cherniavskii

All contributors of this release in alphabetical order: @aarongarciah, @bharatkashyap, @cherniavskii, @danilo-leal, @mnajdova, @oliviertassinari, @ZeeshanTamboli

## v5.15.14

<!-- generated comparing v5.15.13..master -->
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Material UI, Base UI, MUI System, Joy UI
# Contributing to Material UI, MUI System, Joy UI

If you're reading this, you're awesome!
Thank you for being a part of the community and helping us make these projects great.
Expand Down
9 changes: 9 additions & 0 deletions docs/data/about/teamMembers.json
Original file line number Diff line number Diff line change
Expand Up @@ -273,5 +273,14 @@
"locationCountry": "au",
"about": "Enjoy creating open source libraries and reading about AI 🤖",
"github": "atomiks"
},
{
"name": "Aarón García",
"title": "Design Engineer - Core",
"location": "Alicante, Spain",
"locationCountry": "es",
"about": "Minimalism, web development, user experience, football, cycling",
"twitter": "aarongarciah",
"github": "aarongarciah"
}
]
2 changes: 1 addition & 1 deletion docs/data/base/components/accordion/accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/accordion/
<p class="description">Accordions let users show and hide sections of related content on a page.</p>

:::warning
The Base UI Accordion component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38037) to see it arrive sooner.
The Base UI Accordion component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/25) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
<p class="description">Checkboxes give users binary choices when presented with multiple options in a series.</p>

:::warning
The Base UI Checkbox component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38036) to see it arrive sooner.
The Base UI Checkbox component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/24) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/drawer/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ githubLabel: 'component: drawer'
<p class="description">Navigation drawers (also known as sidebars) provide ergonomic access to different destinations without taking the user out of context.</p>

:::warning
The Base UI Drawer component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38181) to see it arrive sooner.
The Base UI Drawer component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/38) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/number-input/number-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ For example, if `min={0}` and `step={2}`, valid values for the component would b
```

:::warning
Support for decimal values and step sizes isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38518) to see it arrive sooner.
Support for decimal values and step sizes isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/41) to see it arrive sooner.
:::

When the input field is in focus, you can enter values that fall outside the valid range.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/base/components/pagination/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ githubLabel: 'component: Pagination'
<p class="description">The Pagination component lets the user select a specific page from a range of pages.</p>

:::warning
The Base UI Pagination component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38042) to see it arrive sooner.
The Base UI Pagination component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/29) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/radio-group/radio-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
<p class="description">Radio buttons enable the user to select one option from a set.</p>

:::warning
The Base UI Radio Group component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38038) to see it arrive sooner.
The Base UI Radio Group component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/26) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/rating/rating.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/tutorials/forms/custom-controls/#a-star-rating
<p class="description">Rating components provide users with a simple action to give feedback as well as assess the opinions of others.</p>

:::warning
The Base UI Rating component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38043) to see it arrive sooner.
The Base UI Rating component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/30) to see it arrive sooner.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ githubLabel: 'component: toggle button'
<p class="description">Toggle Button Groups house sets of buttons with mutually exclusive actions.</p>

:::warning
The Base UI Toggle Button Group component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38044) to see it arrive sooner.
The Base UI Toggle Button Group component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/31) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/tooltip/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/
<p class="description">Tooltips display informative text when users hover over, focus on, or tap an element.</p>

:::warning
The Base UI Tooltip component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38045) to see it arrive sooner.
The Base UI Tooltip component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/base-ui/issues/32) to see it arrive sooner.
:::
5 changes: 0 additions & 5 deletions docs/data/material/components/slider/DiscreteSliderValues.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,12 @@ function valuetext(value) {
return `${value}°C`;
}

function valueLabelFormat(value) {
return marks.findIndex((mark) => mark.value === value) + 1;
}

export default function DiscreteSliderValues() {
return (
<Box sx={{ width: 300 }}>
<Slider
aria-label="Restricted values"
defaultValue={20}
valueLabelFormat={valueLabelFormat}
getAriaValueText={valuetext}
step={null}
valueLabelDisplay="auto"
Expand Down
5 changes: 0 additions & 5 deletions docs/data/material/components/slider/DiscreteSliderValues.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,12 @@ function valuetext(value: number) {
return `${value}°C`;
}

function valueLabelFormat(value: number) {
return marks.findIndex((mark) => mark.value === value) + 1;
}

export default function DiscreteSliderValues() {
return (
<Box sx={{ width: 300 }}>
<Slider
aria-label="Restricted values"
defaultValue={20}
valueLabelFormat={valueLabelFormat}
getAriaValueText={valuetext}
step={null}
valueLabelDisplay="auto"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<Slider
aria-label="Restricted values"
defaultValue={20}
valueLabelFormat={valueLabelFormat}
getAriaValueText={valuetext}
step={null}
valueLabelDisplay="auto"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Then, you can access those variables from the `theme.vars` object:
const Divider = styled('hr')(({ theme }) => ({
height: 1,
border: '1px solid',
borderColor: theme.vars.palette.border.subtile,
borderColor: theme.vars.palette.border.subtle,
backgroundColor: theme.vars.palette.gradient,
}));
```
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/guides/localization/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@

## RTL Support

Right-to-left languages such as Arabic, Persian, or Hebrew are supported.
Right-to-left languages such as Arabic, Persian, Kurdish or Hebrew are supported.

Check warning on line 109 in docs/data/material/guides/localization/localization.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.OxfordComma] Use the Oxford comma in 'Right-to-left languages such as Arabic, Persian, Kurdish or'. Raw Output: {"message": "[Google.OxfordComma] Use the Oxford comma in 'Right-to-left languages such as Arabic, Persian, Kurdish or'.", "location": {"path": "docs/data/material/guides/localization/localization.md", "range": {"start": {"line": 109, "column": 1}}}, "severity": "WARNING"}
ZeeshanTamboli marked this conversation as resolved.
Show resolved Hide resolved
Follow [this guide](/material-ui/customization/right-to-left/) to use them.
5 changes: 0 additions & 5 deletions docs/data/material/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,6 @@ const pages: MuiPage[] = [
pathname: '/material-ui/guides',
title: 'How-to guides',
children: [
{
pathname: '/material-ui/guides/material-3-components',
title: 'Material Design 3 components',
newFeature: true,
},
{ pathname: '/material-ui/guides/minimizing-bundle-size' },
{ pathname: '/material-ui/guides/server-rendering' },
{ pathname: '/material-ui/guides/responsive-ui', title: 'Responsive UI' },
Expand Down
6 changes: 3 additions & 3 deletions docs/notifications.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
"text": "Take a few minutes to share your feedback and expectations in the <a style=\"color: inherit;\" data-ga-event-category=\"Announcement\" data-ga-event-action=\"notification\" data-ga-event-label=\"mui-survey\" href=\"https://tally.so/r/3Ex4PN?source=docs-notification\">Developer Survey</a>."
},
{
"id": 80,
"title": "MUI X v7.0.0-beta.0",
"text": "Featuring new components and multiple enhancements for both developers and end-users. Discover all the specifics in the <a style=\"color: inherit;\" data-ga-event-category=\"Announcement\" data-ga-event-action=\"notification\" data-ga-event-label=\"mui-x-v7-beta\" href=\"https://mui.com/blog/mui-x-v7-beta/\">announcement blog post</a>."
"id": 81,
"title": "Introducing MUI X v7",
"text": "This new version is packed with new components, exciting features, improved usability, and developer experience. Check out the <a style=\"color: inherit;\" data-ga-event-category=\"Announcement\" data-ga-event-action=\"notification\" data-ga-event-label=\"mui-x-v7\" href=\"https://mui.com/blog/mui-x-v7/\">announcement blog post</a>."
}
]
8 changes: 8 additions & 0 deletions docs/pages/_app.js
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ function AppWrapper(props) {
metadata: 'MUI Core',
name: 'Material UI',
versions: [
{
text: 'v6 (next)',
href: `https://next.mui.com${languagePrefix}/material-ui/getting-started/`,
},
{ text: `v${materialPkgJson.version}`, current: true },
{
text: 'v4',
Expand All @@ -192,6 +196,10 @@ function AppWrapper(props) {
metadata: 'MUI Core',
name: 'MUI System',
versions: [
{
text: 'v6 (next)',
href: `https://next.mui.com${languagePrefix}/system/getting-started/`,
},
{ text: `v${systemPkgJson.version}`, current: true },
{ text: 'v4', href: `https://v4.mui.com${languagePrefix}/system/basics/` },
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/base-ui.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default function BaseUI() {
return (
<BrandingCssVarsProvider>
<Head
title="Base UI: Unstyled React components and low-level hooks."
title="Base UI: Unstyled React components and low-level hooks"
description={`Base UI is a library of headless ("unstyled") React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.`}
card="/static/social-previews/baseui-preview.jpg"
>
Expand Down
27 changes: 7 additions & 20 deletions docs/pages/blog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,17 @@ function PostPreview(props: BlogPost) {
'& .MuiAvatar-circular': {
width: 28,
height: 28,
border: 3,
borderColor: '#FFF',
border: `1px solid ${(theme.vars || theme).palette.divider}`,
outline: '3px solid',
outlineColor: '#FFF',
backgroundColor: (theme.vars || theme).palette.grey[100],
color: (theme.vars || theme).palette.grey[800],
fontSize: theme.typography.pxToRem(13),
fontWeight: 500,
},
}),
(theme) =>
theme.applyDarkStyles({
'& .MuiAvatar-circular': {
borderColor: (theme.vars || theme).palette.primaryDark[800],
outlineColor: (theme.vars || theme).palette.primaryDark[900],
backgroundColor: (theme.vars || theme).palette.primaryDark[700],
color: (theme.vars || theme).palette.primaryDark[100],
},
}),
]}
Expand Down Expand Up @@ -167,17 +164,7 @@ function PostPreview(props: BlogPost) {
href={`/blog/${props.slug}`}
id={`describe-${props.slug}`}
endIcon={<KeyboardArrowRightRoundedIcon />}
sx={(theme) => ({
mt: { xs: 1, md: 0 },
mb: { xs: -1, md: 0 },
color: (theme.vars || theme).palette.primary[600],
'& .MuiButton-endIcon': {
ml: 0,
},
...theme.applyDarkStyles({
color: (theme.vars || theme).palette.primary[300],
}),
})}
sx={{ mt: { xs: 0.5, md: 0 }, p: { xs: 0, sm: '6px 8px' } }}
>
Read more
</Button>
Expand Down Expand Up @@ -293,7 +280,7 @@ export default function Blog(props: InferGetStaticPropsType<typeof getStaticProp
flexDirection: 'column',
position: 'relative',
borderColor: 'grey.200',
boxShadow: '0px 4px 16px rgba(170, 180, 190, 0.2)',
boxShadow: '0px 4px 12px rgba(170, 180, 190, 0.2)',
'&:focus-within': {
'& a': {
outline: 0,
Expand All @@ -302,7 +289,7 @@ export default function Blog(props: InferGetStaticPropsType<typeof getStaticProp
},
(theme) =>
theme.applyDarkStyles({
boxShadow: '0px 4px 16px rgba(0, 0, 0, 0.4)',
boxShadow: '0px 4px 12px rgba(0, 0, 0, 0.4)',
}),
]}
>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/blog/2023-toolpad-beta-announcement.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Your input is crucial to helping us shape the roadmap from here.

The best places to stay up-to-date about what we're currently working on are [GitHub issues](https://github.com/mui/mui-toolpad) and our [public roadmap](https://github.com/orgs/mui/projects/9/views/1).

If you have any questions or would like to share feedback, you can directly contact the team at toolpad@mui.com or reach us on [X/Twitter](https://twitter.com/MUI_Toolpad).
If you have any questions or would like to share feedback, you can directly contact the team at toolpad@mui.com or reach us on [X/Twitter](https://twitter.com/Toolpad_).
You can also engage in conversation on our [Discord](https://mui.com/r/discord/) server.

If you'd like an in-depth demo to discuss your use case, please feel free to [schedule a meeting with me on Calendly](https://calendly.com/prakhar-mui).
7 changes: 7 additions & 0 deletions docs/pages/blog/mui-x-v7.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as React from 'react';
import TopLayoutBlog from 'docs/src/modules/components/TopLayoutBlog';
import { docs } from './mui-x-v7.md?muiMarkdown';

export default function Page() {
return <TopLayoutBlog docs={docs} />;
}
Loading
Loading