Skip to content

Commit b385a90

Browse files
authored
Merge pull request #6702 from WiXSL/docs-redirect-mui-v4
Fix MUI's urls reference for version 4
2 parents 98555ea + 5440a21 commit b385a90

File tree

18 files changed

+74
-74
lines changed

18 files changed

+74
-74
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A frontend Framework for building data-driven applications running in the browse
99
## Features
1010

1111
* Adapts to any backend (REST, GraphQL, SOAP, etc.)
12-
* Powered by [material-ui](https://material-ui.com/), [redux](https://redux.js.org/), [react-final-form](https://final-form.org/react), [react-router](https://reacttraining.com/react-router/) and a few more
12+
* Powered by [material-ui](https://v4.mui.com/), [redux](https://redux.js.org/), [react-final-form](https://final-form.org/react), [react-router](https://reacttraining.com/react-router/) and a few more
1313
* Super-fast UI thanks to optimistic rendering (renders before the server returns)
1414
* Undo updates and deletes for a few seconds
1515
* Relationships (many to one, one to many)
@@ -127,7 +127,7 @@ See the [Data Providers documentation](https://marmelab.com/react-admin/DataProv
127127

128128
## Batteries Included But Removable
129129

130-
React-admin is designed as a library of loosely coupled React components built on top of [material-ui](https://material-ui.com/), in addition to custom react hooks exposing reusable controller logic. It is very easy to replace one part of react-admin with your own, e.g. to use a custom datagrid, GraphQL instead of REST, or Bootstrap instead of Material Design.
130+
React-admin is designed as a library of loosely coupled React components built on top of [material-ui](https://v4.mui.com/), in addition to custom react hooks exposing reusable controller logic. It is very easy to replace one part of react-admin with your own, e.g. to use a custom datagrid, GraphQL instead of REST, or Bootstrap instead of Material Design.
131131

132132
## Examples
133133

UPGRADE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Failing to upgrade one of the `ra-` packages will result in a duplication of the
3535
* `react` and `react-dom` are now required to be >= 16.9. This version is backward compatible with 16.3, which was the minimum requirement in react-admin, and it offers the support for Hooks, on which react-admin v3 relies heavily.
3636
* `react-redux` requires a minimum version of 7.1.0 (instead of 5.0). Check their upgrade guide for [6.0](https://github.com/reduxjs/react-redux/releases/tag/v6.0.0) and [7.0](https://github.com/reduxjs/react-redux/releases/tag/v7.0.0)
3737
* `redux-saga` requires a minimum version of 1.0.0 (instead of ~0.16.0). Check their [list of breaking changes for redux-saga 1.0](https://github.com/redux-saga/redux-saga/releases/tag/v1.0.0) on GitHub.
38-
* `material-ui` requires a minimum of 4.0.0 (instead of 1.5). Check their [Upgrade guide](https://next.material-ui.com/guides/migration-v3/).
38+
* `material-ui` requires a minimum of 4.0.0 (instead of 1.5). Check their [Upgrade guide](https://mui.com/guides/migration-v3/).
3939

4040
## `react-router-redux` replaced by `connected-react-router`
4141

@@ -967,7 +967,7 @@ You can replace `<DisabledInput>` with a disabled or read-only `TextInput`. For
967967
+<TextInput source="id" disabled />
968968
```
969969

970-
See material-ui [`TextField` documentation](https://material-ui.com/components/text-fields/#textfield) for available options.
970+
See material-ui [`TextField` documentation](https://v4.mui.com/components/text-fields/#textfield) for available options.
971971

972972
## The SideBar Width Must Be Set Through The `theme`
973973

docs/Admin.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ See the [Theming documentation](./Theming.md#using-a-custom-menu) for more detai
274274

275275
## `theme`
276276

277-
Material UI supports [theming](https://material-ui.com/customization/themes). This lets you customize the look and feel of an admin by overriding fonts, colors, and spacing. You can provide a custom material ui theme by using the `theme` prop:
277+
Material UI supports [theming](https://v4.mui.com/customization/themes). This lets you customize the look and feel of an admin by overriding fonts, colors, and spacing. You can provide a custom material ui theme by using the `theme` prop:
278278

279279
```jsx
280280
import { createMuiTheme } from '@material-ui/core/styles';
@@ -294,7 +294,7 @@ const App = () => (
294294

295295
![Dark theme](./img/dark-theme.png)
296296

297-
For more details on predefined themes and custom themes, refer to the [Material UI Customization documentation](https://material-ui.com/customization/themes/).
297+
For more details on predefined themes and custom themes, refer to the [Material UI Customization documentation](https://v4.mui.com/customization/themes/).
298298

299299
## `layout`
300300

docs/Buttons.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ It also supports [all the other `<Button>` props](#button).
107107
| -------------- | ------------------------------------------------------------------ |
108108
| `floating` | Applied to the underlying `MuiFab` component used in small screens |
109109

110-
To override the style of all instances of `<CreateButton>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaCreateButton` key.
110+
To override the style of all instances of `<CreateButton>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaCreateButton` key.
111111

112112
### `<ListButton>`
113113

@@ -267,7 +267,7 @@ This button is an internal component used by react-admin in [the Filter button/f
267267
| ---------- | ------------------------------------------------------------- |
268268
| `root` | Alternative to using `className`. Applied to the root element |
269269

270-
To override the style of all instances of `<FilterButton>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaFilterButton` key.
270+
To override the style of all instances of `<FilterButton>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaFilterButton` key.
271271

272272
### `<SortButton>`
273273

@@ -317,7 +317,7 @@ Base component for most react-admin buttons. Responsive (displays only the icon
317317
| `disabled` | Optional | `boolean` | `false` | If `true`, the button will be disabled |
318318
| `size` | Optional | `'large' | 'medium' | 'small'` | `'small'` | Button size |
319319

320-
Other props are passed down to [the underlying material-ui `<Button>`](https://material-ui.com/api/button/).
320+
Other props are passed down to [the underlying material-ui `<Button>`](https://v4.mui.com/api/button/).
321321

322322
#### CSS API
323323

@@ -330,7 +330,7 @@ Other props are passed down to [the underlying material-ui `<Button>`](https://m
330330
| `mediumIcon` | Applied to the Button's `children` when `size` prop is `medium` and `alignIcon` prop is 'right' |
331331
| `largeIcon` | Applied to the Button's `children` when `size` prop is `large` and `alignIcon` prop is 'right' |
332332

333-
To override the style of all instances of `<Button>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaButton` key.
333+
To override the style of all instances of `<Button>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaButton` key.
334334

335335
### `<RefreshButton>`
336336
### `<SkipNavigationButton>`
@@ -341,7 +341,7 @@ To override the style of all instances of `<Button>` using the [material-ui styl
341341
| --------------------- | ----------------------------------------------- |
342342
| `skipToContentButton` | Applied to the underlying `MuiButton` component |
343343

344-
To override the style of all instances of `<SkipNavigationButton>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaSkipNavigationButton` key.
344+
To override the style of all instances of `<SkipNavigationButton>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaSkipNavigationButton` key.
345345

346346
### `<MenuItemLink>`
347347

@@ -355,7 +355,7 @@ The `<MenuItemLink>` component displays a menu item with a label and an icon - o
355355
| `primaryText` | Required | `ReactNode` | - | The menu content, displayed when the menu isn't minimized. |
356356
| `leftIcon` | Optional | `ReactNode` | - | The menu icon |
357357

358-
Additional props are passed down to [the underling material-ui `<MenuItem>` component](https://material-ui.com/api/menu-item/#menuitem-api).
358+
Additional props are passed down to [the underling material-ui `<MenuItem>` component](https://v4.mui.com/api/menu-item/#menuitem-api).
359359

360360
You can create a custom menu component using the `<DashboardMenuItem>` and `<MenuItemLink>` components:
361361

@@ -418,7 +418,7 @@ See [The theming documentation](./Theming.md#menuitemlink) for more details.
418418
| `active` | Applied to the underlying `MuiMenuItem`'s `activeClassName` prop |
419419
| `icon` | Applied to the `ListItemIcon` component when `leftIcon` prop is set |
420420

421-
To override the style of all instances of `<MenuItemLink>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaMenuItemLink` key.
421+
To override the style of all instances of `<MenuItemLink>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaMenuItemLink` key.
422422

423423
### `<UserMenu>`
424424

@@ -437,4 +437,4 @@ To override the style of all instances of `<MenuItemLink>` using the [material-u
437437
| `userButton` | Applied to the underlying `MuiButton` component when `useGetIdentity().loaded` is `true` and `useGetIdentity().identity.fullName` is set |
438438
| `avatar` | Applied to the underlying `MuiAvatar` component when `useGetIdentity().avatar` is `true` |
439439

440-
To override the style of all instances of `<UserMenu>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaUserMenu` key.
440+
To override the style of all instances of `<UserMenu>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaUserMenu` key.

docs/CreateEdit.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ You can customize the `<Create>` and `<Edit>` components using the following pro
109109

110110
### CSS API
111111

112-
The `<Create>` and `<Edit>` components accepts the usual `className` prop, but you can override many class names injected to the inner components by React-admin thanks to the `classes` property (as most Material UI components, see their [documentation about it](https://material-ui.com/customization/components/#overriding-styles-with-classes)). This property accepts the following keys:
112+
The `<Create>` and `<Edit>` components accepts the usual `className` prop, but you can override many class names injected to the inner components by React-admin thanks to the `classes` property (as most Material UI components, see their [documentation about it](https://v4.mui.com/customization/components/#overriding-styles-with-classes)). This property accepts the following keys:
113113

114114
| Rule name | Description |
115115
| ----------- | ------------------------------------------------------------------------------------------ |
@@ -118,7 +118,7 @@ The `<Create>` and `<Edit>` components accepts the usual `className` prop, but y
118118
| `noActions` | Applied to the main container when `actions` prop is `false` |
119119
| `card` | Applied to the child component inside the main container (Material UI's `Card` by default) |
120120

121-
To override the style of all instances of `<Create>` and `<Edit>` components using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaCreate` and `RaEdit` keys respectively.
121+
To override the style of all instances of `<Create>` and `<Edit>` components using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaCreate` and `RaEdit` keys respectively.
122122

123123
### Page Title
124124

@@ -1705,7 +1705,7 @@ Here are the props received by the `Toolbar` component when passed as the `toolb
17051705

17061706
### CSS API
17071707

1708-
The `<Toolbar>` accepts the usual `className` prop, but you can override many class names injected to the inner components by React-admin thanks to the `classes` property (as most Material UI components, see their [documentation about it](https://material-ui.com/customization/components/#overriding-styles-with-classes)). This property accepts the following keys:
1708+
The `<Toolbar>` accepts the usual `className` prop, but you can override many class names injected to the inner components by React-admin thanks to the `classes` property (as most Material UI components, see their [documentation about it](https://v4.mui.com/customization/components/#overriding-styles-with-classes)). This property accepts the following keys:
17091709

17101710
| Rule name | Description |
17111711
| ---------------- | ------------------------------------------------------------------------------- |
@@ -1715,7 +1715,7 @@ The `<Toolbar>` accepts the usual `className` prop, but you can override many cl
17151715
| `mobileToolbar` | Applied to the underlying `MuiToolbar` component when `width` prop is `xs` |
17161716
| `spacer` | Applied to the div below the underlying `MuiToolbar` used as spacer |
17171717

1718-
To override the style of all instances of `<Toolbar>` components using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaToolbar` key.
1718+
To override the style of all instances of `<Toolbar>` components using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaToolbar` key.
17191719

17201720
**Tip**: Use react-admin's `<Toolbar>` component instead of material-ui's `<Toolbar>` component. The former builds upon the latter and adds support for an alternative mobile layout (and is therefore responsive).
17211721

@@ -1926,7 +1926,7 @@ The `<SimpleForm>` and `<TabbedForm>` layouts are quite simple. In order to bett
19261926

19271927
![custom form layout](./img/custom-form-layout.png)
19281928

1929-
Here is an example of such custom form, taken from the Posters Galore demo. It uses [material-ui's `<Box>` component](https://material-ui.com/components/box/), and it's a good starting point for your custom form layouts.
1929+
Here is an example of such custom form, taken from the Posters Galore demo. It uses [material-ui's `<Box>` component](https://v4.mui.com/components/box/), and it's a good starting point for your custom form layouts.
19301930

19311931
```jsx
19321932
import * as React from "react";

docs/Fields.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ import { BooleanField } from 'react-admin';
156156
| ---------- | --------------------------- |
157157
| `root` | Applied to the root element |
158158

159-
To override the style of all instances of `<BooleanField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaBooleanField` key.
159+
To override the style of all instances of `<BooleanField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaBooleanField` key.
160160

161161
#### Usage
162162

@@ -183,15 +183,15 @@ import AlarmOffIcon from '@material-ui/icons/AlarmOff';
183183

184184
### `<ChipField>`
185185

186-
Displays a value inside a ["Chip"](https://material-ui.com/components/chips), which is Material UI's term for a label.
186+
Displays a value inside a ["Chip"](https://v4.mui.com/components/chips), which is Material UI's term for a label.
187187

188188
#### CSS API
189189

190190
| Rule name | Description |
191191
| ---------- | -------------------------------------------------------- |
192192
| `chip` | Applied to the underlying Material UI's `Chip` component |
193193

194-
To override the style of all instances of `<ChipField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaChipField` key.
194+
To override the style of all instances of `<ChipField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaChipField` key.
195195

196196
#### Usage
197197

@@ -215,7 +215,7 @@ import { ChipField, SingleFieldList, ReferenceManyField } from 'react-admin';
215215
</ReferenceManyField>
216216
```
217217

218-
Any additional props are passed to material-ui's `<Chip>` element. Check [The material-ui `<Chip>` documentation](https://material-ui.com/api/chip/) for details.
218+
Any additional props are passed to material-ui's `<Chip>` element. Check [The material-ui `<Chip>` documentation](https://v4.mui.com/api/chip/) for details.
219219

220220
### `<DateField>`
221221

@@ -328,7 +328,7 @@ This field is also often used within the [<ImageInput />](./Inputs.md#imageinput
328328
| `list` | Applied to the underlying `<ul>` component when `sourceValue` prop is an array |
329329
| `image` | Applied to each underlying `<img>` component |
330330

331-
To override the style of all instances of `<ImageField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaImageField` key.
331+
To override the style of all instances of `<ImageField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaImageField` key.
332332

333333
#### Usage
334334

@@ -394,7 +394,7 @@ This field is also often used within an [<FileInput />](./Inputs.md#fileinput) c
394394
| ---------- | --------------------------- |
395395
| `root` | Applied to the root element |
396396

397-
To override the style of all instances of `<FileField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaFileField` key.
397+
To override the style of all instances of `<FileField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaFileField` key.
398398

399399
#### Usage
400400

@@ -792,7 +792,7 @@ With this configuration, `<ReferenceField>` wraps the user's name in a link to t
792792
| ---------- | ----------------------------- |
793793
| `link` | Applied to each child element |
794794

795-
To override the style of all instances of `<ReferenceField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaReferenceField` key.
795+
To override the style of all instances of `<ReferenceField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaReferenceField` key.
796796

797797
#### Usage
798798

@@ -1088,7 +1088,7 @@ export const PostList = (props) => (
10881088
| ---------- | -------------------------------------------------------------------------------------- |
10891089
| `progress` | Applied to the Material UI's `LinearProgress` component while `loaded` prop is `false` |
10901090

1091-
To override the style of all instances of `<ReferenceArrayField>` using the [material-ui style overrides](https://material-ui.com/customization/globals/#css), use the `RaReferenceArrayField` key.
1091+
To override the style of all instances of `<ReferenceArrayField>` using the [material-ui style overrides](https://v4.mui.com/customization/globals/#css), use the `RaReferenceArrayField` key.
10921092

10931093
#### Usage
10941094

@@ -1266,7 +1266,7 @@ The same pattern applies to show views when you don't want to display all transl
12661266

12671267
### Styling Fields
12681268

1269-
All field components accept a `className` prop, allowing you to customize their style to your liking. We advise you to use the Material UI styling solution, JSS, to generate those classes. See their [documentation](https://material-ui.com/customization/css-in-js/#api) about that.
1269+
All field components accept a `className` prop, allowing you to customize their style to your liking. We advise you to use the Material UI styling solution, JSS, to generate those classes. See their [documentation](https://v4.mui.com/customization/css-in-js/#api) about that.
12701270

12711271
```jsx
12721272
import { makeStyles } from '@material-ui/core/styles';

0 commit comments

Comments
 (0)