Skip to content

Commit 24e109c

Browse files
[docs] Improve version display
1 parent ddea909 commit 24e109c

File tree

6 files changed

+35
-25
lines changed

6 files changed

+35
-25
lines changed

docs/src/modules/components/Demo.js

+25-6
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,33 @@ const styles = theme => ({
5656
margin: 'auto',
5757
display: 'flex',
5858
justifyContent: 'center',
59+
[theme.breakpoints.up('sm')]: {
60+
borderRadius: theme.shape.borderRadius,
61+
},
62+
},
63+
/* Isolate the demo with an outline. */
64+
demoBgOutlined: {
65+
padding: theme.spacing(3),
66+
border: `1px solid ${fade(theme.palette.action.active, 0.12)}`,
5967
borderLeftWidth: 0,
6068
borderRightWidth: 0,
61-
border: `1px solid ${fade(theme.palette.action.active, 0.12)}`,
62-
padding: theme.spacing(3),
6369
[theme.breakpoints.up('sm')]: {
64-
borderRadius: theme.shape.borderRadius,
6570
borderLeftWidth: 1,
6671
borderRightWidth: 1,
6772
},
6873
},
69-
demoBg: {
70-
border: 'none',
74+
/* Prepare the background to display an inner elevation. */
75+
demoBgTrue: {
76+
padding: theme.spacing(3),
7177
backgroundColor: theme.palette.background.level2,
7278
},
79+
/* Make no difference between the demo and the markdown. */
80+
demoBgInline: {
81+
// Maintain alignment with the markdown text
82+
[theme.breakpoints.down('xs')]: {
83+
padding: theme.spacing(3),
84+
},
85+
},
7386
demoHiddenHeader: {
7487
paddingTop: theme.spacing(2),
7588
[theme.breakpoints.up('sm')]: {
@@ -250,6 +263,10 @@ function Demo(props) {
250263
[demoOptions.height, demoOptions.maxWidth],
251264
);
252265

266+
if (demoOptions.bg == null) {
267+
demoOptions.bg = 'outlined';
268+
}
269+
253270
if (demoOptions.iframe) {
254271
demoOptions.bg = true;
255272
}
@@ -298,7 +315,9 @@ function Demo(props) {
298315
<div
299316
className={clsx(classes.demo, {
300317
[classes.demoHiddenHeader]: demoOptions.hideHeader,
301-
[classes.demoBg]: demoOptions.bg,
318+
[classes.demoBgOutlined]: demoOptions.bg === 'outlined',
319+
[classes.demoBgTrue]: demoOptions.bg === true,
320+
[classes.demoBgInline]: demoOptions.bg === 'inline',
302321
})}
303322
tabIndex={-1}
304323
onMouseEnter={handleDemoHover}

docs/src/pages/discover-more/showcase/Showcase.js

-7
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ import appList from './appList';
1717
const styles = theme => ({
1818
root: {
1919
flexGrow: 1,
20-
backgroundColor: theme.palette.background.default,
21-
// Hide the demo container padding
22-
margin: -theme.spacing(3),
23-
// Maintain alignment with the markdown text
24-
[theme.breakpoints.down('xs')]: {
25-
padding: 30,
26-
},
2720
},
2821
formControl: {
2922
marginBottom: theme.spacing(4),

docs/src/pages/discover-more/showcase/showcase.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Want to add your app? Found an app that no longer works or no longer uses Materi
88
- High traffic
99
- Open source
1010

11-
{{"demo": "pages/discover-more/showcase/Showcase.js", "hideHeader": true, "bg": true}}
11+
{{"demo": "pages/discover-more/showcase/Showcase.js", "hideHeader": true, "bg": "inline"}}

docs/src/pages/versions/LatestVersions.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import Table from '@material-ui/core/Table';
55
import TableBody from '@material-ui/core/TableBody';
66
import TableCell from '@material-ui/core/TableCell';
77
import TableRow from '@material-ui/core/TableRow';
8-
import Paper from '@material-ui/core/Paper';
98
import Typography from '@material-ui/core/Typography';
109
import Link from 'docs/src/modules/components/Link';
1110

@@ -19,7 +18,7 @@ function LatestVersions(props) {
1918
const { classes } = props;
2019

2120
return (
22-
<Paper className={classes.root}>
21+
<div className={classes.root}>
2322
<Table>
2423
<TableBody>
2524
<TableRow>
@@ -72,7 +71,7 @@ function LatestVersions(props) {
7271
</TableRow>
7372
</TableBody>
7473
</Table>
75-
</Paper>
74+
</div>
7675
);
7776
}
7877

docs/src/pages/versions/StableVersions.js

+4-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import Table from '@material-ui/core/Table';
88
import TableBody from '@material-ui/core/TableBody';
99
import TableCell from '@material-ui/core/TableCell';
1010
import TableRow from '@material-ui/core/TableRow';
11-
import Paper from '@material-ui/core/Paper';
1211
import Typography from '@material-ui/core/Typography';
1312
import Link from 'docs/src/modules/components/Link';
1413

@@ -17,7 +16,7 @@ const FILTERED_BRANCHES = ['latest', 'staging', 'l10n', 'next'];
1716

1817
const styles = {
1918
root: {
20-
height: 410,
19+
minHeight: 33 * 11,
2120
overflow: 'auto',
2221
width: '100%',
2322
},
@@ -72,8 +71,8 @@ function StableVersions(props) {
7271
}, []);
7372

7473
return (
75-
<Paper className={classes.root}>
76-
<Table size="small">
74+
<div className={classes.root}>
75+
<Table>
7776
<TableBody>
7877
{docs.map(doc => (
7978
<TableRow key={doc.version}>
@@ -104,7 +103,7 @@ function StableVersions(props) {
104103
))}
105104
</TableBody>
106105
</Table>
107-
</Paper>
106+
</div>
108107
);
109108
}
110109

docs/src/pages/versions/versions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
The most recent version is recommended in production.
88

9-
{{"demo": "pages/versions/StableVersions.js", "hideHeader": true}}
9+
{{"demo": "pages/versions/StableVersions.js", "hideHeader": true, "bg": "inline"}}
1010

1111
## Latest versions
1212

1313
Here you can find the latest unreleased documentation and code.
1414
You can use it to see what changes are coming and provide better feedback to Material-UI contributors.
1515

16-
{{"demo": "pages/versions/LatestVersions.js", "hideHeader": true}}
16+
{{"demo": "pages/versions/LatestVersions.js", "hideHeader": true, "bg": "inline"}}
1717

1818
## Versioning strategy
1919

@@ -44,7 +44,7 @@ In general, you can expect the following release cycle:
4444
## Release schedule
4545

4646
| Date | Version | Status |
47-
|:-----|:--------|--------|
47+
|:-----|:--------|:-------|
4848
| May 2018 | v1.0.0 | Released |
4949
| Septembre 2018 | v3.0.0 | Released |
5050
| May 2019 | v4.0.0 | Released |

0 commit comments

Comments
 (0)