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] Add TS demos for SimpleNoSsr and FrameDeferring #17913

Merged
merged 6 commits into from
Oct 19, 2019
Merged
Show file tree
Hide file tree
Changes from 5 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
34 changes: 19 additions & 15 deletions docs/src/pages/components/no-ssr/FrameDeferring.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@ import NoSsr from '@material-ui/core/NoSsr';

const useStyles = makeStyles({
container: {
maxWidth: 300,
wordBreak: 'break-all',
width: 300,
display: 'flex',
flexWrap: 'wrap',
},
});

function LargeTree() {
return Array.from(new Array(3000)).map((_, index) => <span key={index}>.</span>);
return Array.from(new Array(5000)).map((_, index) => <span key={index}>.</span>);
}

function FrameDeferring() {
export default function FrameDeferring() {
const classes = useStyles();
const [state, setState] = React.useState({ open: false, defer: false });

Expand All @@ -30,6 +31,7 @@ function FrameDeferring() {
>
{'Render NoSsr defer="false"'}
</button>
<br />
<button
type="button"
onClick={() =>
Expand All @@ -41,17 +43,19 @@ function FrameDeferring() {
>
{'Render NoSsr defer="true"'}
</button>
{state.open ? (
<div className={classes.container}>
<span>Outside NoSsr</span>
<NoSsr defer={state.defer}>
....Inside NoSsr
<LargeTree />
</NoSsr>
</div>
) : null}
<br />
<br />
<div className={classes.container}>
{state.open ? (
<React.Fragment>
<div>Outside NoSsr</div>
<NoSsr defer={state.defer}>
.....Inside NoSsr
<LargeTree />
</NoSsr>
</React.Fragment>
) : null}
</div>
</div>
);
}

export default FrameDeferring;
61 changes: 61 additions & 0 deletions docs/src/pages/components/no-ssr/FrameDeferring.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import React from 'react';
import { makeStyles } from '@material-ui/core/styles';
import NoSsr from '@material-ui/core/NoSsr';

const useStyles = makeStyles({
container: {
width: 300,
display: 'flex',
flexWrap: 'wrap',
},
});

function LargeTree(): any {
return Array.from(new Array(5000)).map((_, index) => <span key={index}>.</span>);
}

export default function FrameDeferring() {
const classes = useStyles();
const [state, setState] = React.useState({ open: false, defer: false });

return (
<div>
<button
type="button"
onClick={() =>
setState({
open: !state.open,
defer: false,
})
}
>
{'Render NoSsr defer="false"'}
</button>
<br />
<button
type="button"
onClick={() =>
setState({
open: !state.open,
defer: true,
})
}
>
{'Render NoSsr defer="true"'}
</button>
<br />
<br />
<div className={classes.container}>
{state.open ? (
<React.Fragment>
<div>Outside NoSsr</div>
<NoSsr defer={state.defer}>
.....Inside NoSsr
<LargeTree />
</NoSsr>
</React.Fragment>
) : null}
</div>
</div>
);
}
31 changes: 7 additions & 24 deletions docs/src/pages/components/no-ssr/SimpleNoSsr.js
Original file line number Diff line number Diff line change
@@ -1,35 +1,18 @@
import React from 'react';
import PropTypes from 'prop-types';
import { withStyles } from '@material-ui/core/styles';
import NoSsr from '@material-ui/core/NoSsr';
import Button from '@material-ui/core/Button';

const styles = theme => ({
button: {
display: 'block',
margin: theme.spacing(2),
},
});

function SimpleNoSsr(props) {
const { classes } = props;
import Box from '@material-ui/core/Box';

export default function SimpleNoSsr() {
return (
<div>
<Button className={classes.button} variant="contained" color="primary">
Server & Client
</Button>
<Box p={2} bgcolor="primary.main" color="primary.contrastText">
Server and Client
</Box>
<NoSsr>
<Button className={classes.button} variant="contained" color="secondary">
<Box p={2} bgcolor="secondary.main" color="primary.contrastText">
Client only
</Button>
</Box>
</NoSsr>
</div>
);
}

SimpleNoSsr.propTypes = {
classes: PropTypes.object.isRequired,
};

export default withStyles(styles)(SimpleNoSsr);
18 changes: 18 additions & 0 deletions docs/src/pages/components/no-ssr/SimpleNoSsr.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import React from 'react';
import NoSsr from '@material-ui/core/NoSsr';
import Box from '@material-ui/core/Box';

export default function SimpleNoSsr() {
return (
<div>
<Box p={2} bgcolor="primary.main" color="primary.contrastText">
Server and Client
</Box>
<NoSsr>
<Box p={2} bgcolor="secondary.main" color="primary.contrastText">
Client only
</Box>
</NoSsr>
</div>
);
}
26 changes: 25 additions & 1 deletion packages/material-ui/src/NoSsr/NoSsr.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const useEnhancedEffect =
function NoSsr(props) {
const { children, defer = false, fallback = null } = props;
const [mountedState, setMountedState] = React.useState(false);
const mounted = React.useRef();

useEnhancedEffect(() => {
if (!defer) {
Expand All @@ -28,8 +29,31 @@ function NoSsr(props) {

React.useEffect(() => {
if (defer) {
setMountedState(true);
mounted.current = true;
// Wondering why we use two RAFs? Check this video out:
// https://www.youtube.com/watch?v=cCOL7MC4Pl0
//
// The useEffect() method is called after the DOM nodes are inserted.
// The UI might not have rendering the changes. We request a frame.
requestAnimationFrame(() => {
// The browser should be about to render the DOM nodes
// that React committed at this point.
// We don't want to interrupt. Let's wait the next frame.
requestAnimationFrame(() => {
// The UI is up-to-date at this point.
// We can continue rendering the children.
if (mounted.current) {
setMountedState(true);
}
});
});

return () => {
mounted.current = false;
};
}

return undefined;
}, [defer]);

// We need the Fragment here to force react-docgen to recognise NoSsr as a component.
Expand Down
9 changes: 7 additions & 2 deletions packages/material-ui/src/NoSsr/NoSsr.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,18 @@ describe('<NoSsr />', () => {
});

describe('prop: defer', () => {
it('should defer the rendering', () => {
it('should defer the rendering', done => {
const wrapper = mount(
<NoSsr defer>
<span id="client-only">Hello</span>
</NoSsr>,
);
assert.strictEqual(wrapper.find('#client-only').exists(), true);
assert.strictEqual(wrapper.find('#client-only').exists(), false);
setTimeout(() => {
wrapper.update();
assert.strictEqual(wrapper.find('#client-only').exists(), true);
done();
}, 300);
});
});
});