diff --git a/docs/pages/api-docs/icon-button.md b/docs/pages/api-docs/icon-button.md
index 5a63b1d6513328..01d1e5407bd450 100644
--- a/docs/pages/api-docs/icon-button.md
+++ b/docs/pages/api-docs/icon-button.md
@@ -73,5 +73,4 @@ You can take advantage of this behavior to [target nested components](/guides/ap
- [Buttons](/components/buttons/)
- [Grid List](/components/grid-list/)
-- [Image List](/components/image-list/)
diff --git a/docs/pages/api-docs/image-list-tile-bar.js b/docs/pages/api-docs/image-list-item-bar.js
similarity index 85%
rename from docs/pages/api-docs/image-list-tile-bar.js
rename to docs/pages/api-docs/image-list-item-bar.js
index cf3b33ee40c355..edb472fed02622 100644
--- a/docs/pages/api-docs/image-list-tile-bar.js
+++ b/docs/pages/api-docs/image-list-item-bar.js
@@ -2,8 +2,8 @@ import React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';
-const pageFilename = 'api/image-list-tile-bar';
-const requireRaw = require.context('!raw-loader!./', false, /\/image-list-tile-bar\.md$/);
+const pageFilename = 'api/image-list-item-bar';
+const requireRaw = require.context('!raw-loader!./', false, /\/image-list-item-bar\.md$/);
export default function Page({ docs }) {
return
The API documentation of the ImageListTileBar React component. Learn more about the props and the CSS customization points.
+The API documentation of the ImageListItemBar React component. Learn more about the props and the CSS customization points.
## Import ```js -import ImageListTileBar from '@material-ui/core/ImageListTileBar'; +import ImageListItemBar from '@material-ui/core/ImageListItemBar'; // or -import { ImageListTileBar } from '@material-ui/core'; +import { ImageListItemBar } from '@material-ui/core'; ``` You can learn more about the difference by [reading this guide](/guides/minimizing-bundle-size/). @@ -22,7 +22,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi ## Component name -The `MuiImageListTileBar` name can be used for providing [default props](/customization/globals/#default-props) or [style overrides](/customization/globals/#css) at the theme level. +The `MuiImageListItemBar` name can be used for providing [default props](/customization/globals/#default-props) or [style overrides](/customization/globals/#css) at the theme level. ## Props @@ -43,17 +43,17 @@ Any other props supplied will be provided to the root element (native element). | Rule name | Global class | Description | |:-----|:-------------|:------------| -| root | .MuiImageListTileBar-root | Styles applied to the root element. -| titlePositionBottom | .MuiImageListTileBar-titlePositionBottom | Styles applied to the root element if `titlePosition="bottom"`. -| titlePositionTop | .MuiImageListTileBar-titlePositionTop | Styles applied to the root element if `titlePosition="top"`. -| rootSubtitle | .MuiImageListTileBar-rootSubtitle | Styles applied to the root element if a `subtitle` is provided. -| titleWrap | .MuiImageListTileBar-titleWrap | Styles applied to the title and subtitle container element. -| titleWrapActionPosLeft | .MuiImageListTileBar-titleWrapActionPosLeft | Styles applied to the container element if `actionPosition="left"`. -| titleWrapActionPosRight | .MuiImageListTileBar-titleWrapActionPosRight | Styles applied to the container element if `actionPosition="right"`. -| title | .MuiImageListTileBar-title | Styles applied to the title container element. -| subtitle | .MuiImageListTileBar-subtitle | Styles applied to the subtitle container element. -| actionIcon | .MuiImageListTileBar-actionIcon | Styles applied to the actionIcon if supplied. -| actionIconActionPosLeft | .MuiImageListTileBar-actionIconActionPosLeft | Styles applied to the actionIcon if `actionPosition="left"`. +| root | .MuiImageListItemBar-root | Styles applied to the root element. +| titlePositionBottom | .MuiImageListItemBar-titlePositionBottom | Styles applied to the root element if `titlePosition="bottom"`. +| titlePositionTop | .MuiImageListItemBar-titlePositionTop | Styles applied to the root element if `titlePosition="top"`. +| rootSubtitle | .MuiImageListItemBar-rootSubtitle | Styles applied to the root element if a `subtitle` is provided. +| titleWrap | .MuiImageListItemBar-titleWrap | Styles applied to the title and subtitle container element. +| titleWrapActionPosLeft | .MuiImageListItemBar-titleWrapActionPosLeft | Styles applied to the container element if `actionPosition="left"`. +| titleWrapActionPosRight | .MuiImageListItemBar-titleWrapActionPosRight | Styles applied to the container element if `actionPosition="right"`. +| title | .MuiImageListItemBar-title | Styles applied to the title container element. +| subtitle | .MuiImageListItemBar-subtitle | Styles applied to the subtitle container element. +| actionIcon | .MuiImageListItemBar-actionIcon | Styles applied to the actionIcon if supplied. +| actionIconActionPosLeft | .MuiImageListItemBar-actionIconActionPosLeft | Styles applied to the actionIcon if `actionPosition="left"`. You can override the style of the component thanks to one of these customization points: @@ -61,7 +61,7 @@ You can override the style of the component thanks to one of these customization - With a [global class name](/customization/components/#overriding-styles-with-global-class-names). - With a theme and an [`overrides` property](/customization/globals/#css). -If that's not sufficient, you can check the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/ImageListTileBar/ImageListTileBar.js) for more detail. +If that's not sufficient, you can check the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/ImageListItemBar/ImageListItemBar.js) for more detail. ## Demos diff --git a/docs/pages/api-docs/image-list-tile.js b/docs/pages/api-docs/image-list-item.js similarity index 87% rename from docs/pages/api-docs/image-list-tile.js rename to docs/pages/api-docs/image-list-item.js index 87e81591cb6d14..b6bf73a4e99c11 100644 --- a/docs/pages/api-docs/image-list-tile.js +++ b/docs/pages/api-docs/image-list-item.js @@ -2,8 +2,8 @@ import React from 'react'; import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown'; -const pageFilename = 'api/image-list-tile'; -const requireRaw = require.context('!raw-loader!./', false, /\/image-list-tile\.md$/); +const pageFilename = 'api/image-list-item'; +const requireRaw = require.context('!raw-loader!./', false, /\/image-list-item\.md$/); export default function Page({ docs }) { returnThe API documentation of the ImageListTile React component. Learn more about the props and the CSS customization points.
+The API documentation of the ImageListItem React component. Learn more about the props and the CSS customization points.
## Import ```js -import ImageListTile from '@material-ui/core/ImageListTile'; +import ImageListItem from '@material-ui/core/ImageListItem'; // or -import { ImageListTile } from '@material-ui/core'; +import { ImageListItem } from '@material-ui/core'; ``` You can learn more about the difference by [reading this guide](/guides/minimizing-bundle-size/). @@ -22,7 +22,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi ## Component name -The `MuiImageListTile` name can be used for providing [default props](/customization/globals/#default-props) or [style overrides](/customization/globals/#css) at the theme level. +The `MuiImageListItem` name can be used for providing [default props](/customization/globals/#default-props) or [style overrides](/customization/globals/#css) at the theme level. ## Props @@ -39,10 +39,10 @@ Any other props supplied will be provided to the root element (native element). | Rule name | Global class | Description | |:-----|:-------------|:------------| -| root | .MuiImageListTile-root | Styles applied to the root element. -| tile | .MuiImageListTile-tile | Styles applied to the `div` element that wraps the children. -| imgFullHeight | .MuiImageListTile-imgFullHeight | Styles applied to an `img` element child, if needed to ensure it covers the tile. -| imgFullWidth | .MuiImageListTile-imgFullWidth | Styles applied to an `img` element child, if needed to ensure it covers the tile. +| root | .MuiImageListItem-root | Styles applied to the root element. +| tile | .MuiImageListItem-tile | Styles applied to the `div` element that wraps the children. +| imgFullHeight | .MuiImageListItem-imgFullHeight | Styles applied to an `img` element child, if needed to ensure it covers the tile. +| imgFullWidth | .MuiImageListItem-imgFullWidth | Styles applied to an `img` element child, if needed to ensure it covers the tile. You can override the style of the component thanks to one of these customization points: @@ -50,7 +50,7 @@ You can override the style of the component thanks to one of these customization - With a [global class name](/customization/components/#overriding-styles-with-global-class-names). - With a theme and an [`overrides` property](/customization/globals/#css). -If that's not sufficient, you can check the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/ImageListTile/ImageListTile.js) for more detail. +If that's not sufficient, you can check the [implementation of the component](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/ImageListItem/ImageListItem.js) for more detail. ## Demos diff --git a/docs/pages/api-docs/list-subheader.md b/docs/pages/api-docs/list-subheader.md index 3422c7c9bdc55d..1e174241c8682d 100644 --- a/docs/pages/api-docs/list-subheader.md +++ b/docs/pages/api-docs/list-subheader.md @@ -62,6 +62,5 @@ If that's not sufficient, you can check the [implementation of the component](ht ## Demos - [Grid List](/components/grid-list/) -- [Image List](/components/image-list/) - [Lists](/components/lists/) diff --git a/docs/src/pages/components/cards/cards.md b/docs/src/pages/components/cards/cards.md index 6377dbe052caf3..ee050a6c6754c3 100644 --- a/docs/src/pages/components/cards/cards.md +++ b/docs/src/pages/components/cards/cards.md @@ -25,7 +25,7 @@ Set `variant="outlined"` to render an outlined card. ## Complex Interaction -On desktop, card content can expand. +On desktop, card content can expand. (Click the downward chevron to view the recipe.) {{"demo": "pages/components/cards/RecipeReviewCard.js", "bg": true}} diff --git a/docs/src/pages/components/image-list/AdvancedImageList.js b/docs/src/pages/components/image-list/AdvancedImageList.js index 5225564b6b9d7e..0c12cf2ff95729 100644 --- a/docs/src/pages/components/image-list/AdvancedImageList.js +++ b/docs/src/pages/components/image-list/AdvancedImageList.js @@ -1,8 +1,8 @@ import React from 'react'; import { makeStyles } from '@material-ui/core/styles'; import ImageList from '@material-ui/core/ImageList'; -import ImageListTile from '@material-ui/core/ImageListTile'; -import ImageListTileBar from '@material-ui/core/ImageListTileBar'; +import ImageListItem from '@material-ui/core/ImageListItem'; +import ImageListItemBar from '@material-ui/core/ImageListItemBar'; import IconButton from '@material-ui/core/IconButton'; import StarBorderIcon from '@material-ui/icons/StarBorder'; import tileData from './tileData'; @@ -56,9 +56,9 @@ export default function AdvancedImageList() {Yeah, v5 has been released!
+ +Looking for the v4 docs? [Find them here](https://material-ui.com/versions/). + +> This document is a work in progress. +> Have you upgraded your site and run into something that's not covered here? +> [Add your changes on GitHub](https://github.com/mui-org/material-ui/blob/next/docs/src/pages/guides/migration-v4/migration-v4.md). + +## Introduction + +This is a reference for upgrading your site from Material-UI v4 to v5. +While there's a lot covered here, you probably won't need to do everything for your site. +We'll do our best to keep things easy to follow, and as sequential as possible so you can quickly get rocking on v5! + +## Why you should migrate + +This documentation page covers the _how_ of migrating from v4 to v5. +The _why_ is covered in the [release blog post on Medium](https://medium.com/material-ui/material-ui-v4-is-out-4b7587d1e701). + +## Updating your dependencies + +The very first thing you will need to do is to update your dependencies. + +### Update Material-UI version + +You need to update your `package.json` to use the latest version of Material-UI. + +```json +"dependencies": { + "@material-ui/core": "^5.0.0-alpha.1" +} +``` + +Or run + +```sh +npm install @material-ui/core@next + +or + +yarn add @material-ui/core@next +``` + +## Handling breaking changes + +### non-ref-forwarding class components + +Support for non-ref-forwarding class components in the `component` prop or as an immediate `children` has been dropped. If you were using `unstable_createStrictModeTheme` or didn't see any warnings related to `findDOMNode` in `React.StrictMode` then you don't need to do anything. +Otherwise check out the ["Caveat with refs" section in our composition guide](/guides/composition/#caveat-with-refs) to find out how to migrate. +This change affects almost all components where you're using the `component` prop or passing `children` to components that require `children` to be elements (e.g. `