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.

Sign up for GitHub

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

Jump to bottom

[Snackbar] Convert to function component #15504

Merged
merged 6 commits into from Apr 27, 2019
Merged

[Snackbar] Convert to function component #15504

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dae6578
initial commit for converting to functional component
adeelibr Apr 26, 2019
c0092bc
clean code
adeelibr Apr 26, 2019
d898819
ran prettier
adeelibr Apr 26, 2019
2c32557
removed getDeriveStateFromProp equivalent
adeelibr Apr 26, 2019
05f622a
removed unnecessary export
adeelibr Apr 26, 2019
7a65308
all tests pass =D
adeelibr Apr 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
280 changes: 125 additions & 155 deletions packages/material-ui/src/Snackbar/Snackbar.js
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@ import withStyles from '../styles/withStyles';
import { duration } from '../styles/transitions';
import ClickAwayListener from '../ClickAwayListener';
import { capitalize, createChainedFunction } from '../utils/helpers';
import withForwardedRef from '../utils/withForwardedRef';
import Grow from '../Grow';
import SnackbarContent from '../SnackbarContent';

Expand Down Expand Up @@ -95,181 +94,157 @@ export const styles = theme => {
};
};

class Snackbar extends React.Component {
state = {};
const Snackbar = React.forwardRef(function Snackbar(props, ref) {
const {
action,
anchorOrigin: { vertical, horizontal },
autoHideDuration,
children,
classes,
className,
ClickAwayListenerProps,
ContentProps,
disableWindowBlurListener,
message,
onClose,
onEnter,
onEntered,
onEntering,
onExit,
onExited,
onExiting,
onMouseEnter,
onMouseLeave,
open,
resumeHideDuration,
TransitionComponent,
transitionDuration,
TransitionProps,
...other
} = props;

componentDidMount() {
if (this.props.open) {
this.setAutoHideTimer();
}
}

componentDidUpdate(prevProps) {
if (prevProps.open !== this.props.open) {
if (this.props.open) {
this.setAutoHideTimer();
} else {
clearTimeout(this.timerAutoHide);
}
}
}

componentWillUnmount() {
clearTimeout(this.timerAutoHide);
}

static getDerivedStateFromProps(nextProps, prevState) {
if (typeof prevState.exited === 'undefined') {
return {
exited: !nextProps.open,
};
}

if (nextProps.open) {
return {
exited: false,
};
}

return null;
}
const timerAutoHide = React.useRef();
const [exited, setExited] = React.useState();
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

// Timer that controls delay before snackbar auto hides
setAutoHideTimer(autoHideDuration) {
const autoHideDurationBefore =
autoHideDuration != null ? autoHideDuration : this.props.autoHideDuration;

if (!this.props.onClose || autoHideDurationBefore == null) {
return;
}
const setAutoHideTimer = React.useCallback(
autoHideDurationParam => {
const autoHideDurationBefore =
autoHideDurationParam != null ? autoHideDurationParam : autoHideDuration;

clearTimeout(this.timerAutoHide);
this.timerAutoHide = setTimeout(() => {
const autoHideDurationAfter =
autoHideDuration != null ? autoHideDuration : this.props.autoHideDuration;
if (!this.props.onClose || autoHideDurationAfter == null) {
if (!onClose || autoHideDurationBefore == null) {
return;
}

this.props.onClose(null, 'timeout');
}, autoHideDurationBefore);
}

handleMouseEnter = event => {
if (this.props.onMouseEnter) {
this.props.onMouseEnter(event);
}
this.handlePause();
};
clearTimeout(timerAutoHide.current);
timerAutoHide.current = setTimeout(() => {
const autoHideDurationAfter =
autoHideDurationParam != null ? autoHideDurationParam : autoHideDuration;
if (!onClose || autoHideDurationAfter == null) {
return;
}
onClose(null, 'timeout');
}, autoHideDurationBefore);
},
[autoHideDuration, onClose],
);

handleMouseLeave = event => {
if (this.props.onMouseLeave) {
this.props.onMouseLeave(event);
}
this.handleResume();
};
React.useEffect(() => {
if (open) setAutoHideTimer();

handleClickAway = event => {
if (this.props.onClose) {
this.props.onClose(event, 'clickaway');
}
};
return () => {
clearTimeout(timerAutoHide.current);
};
}, [open, setAutoHideTimer]);

// Pause the timer when the user is interacting with the Snackbar
// or when the user hide the window.
handlePause = () => {
clearTimeout(this.timerAutoHide);
const handlePause = () => {
clearTimeout(timerAutoHide.current);
};

// Restart the timer when the user is no longer interacting with the Snackbar
// or when the window is shown back.
handleResume = () => {
if (this.props.autoHideDuration != null) {
if (this.props.resumeHideDuration != null) {
this.setAutoHideTimer(this.props.resumeHideDuration);
const handleResume = () => {
if (autoHideDuration != null) {
if (resumeHideDuration != null) {
setAutoHideTimer(resumeHideDuration);
return;
}
this.setAutoHideTimer(this.props.autoHideDuration * 0.5);
setAutoHideTimer(autoHideDuration * 0.5);
}
};

handleExited = () => {
this.setState({ exited: true });
const handleMouseEnter = event => {
if (onMouseEnter) {
onMouseEnter(event);
}
handlePause();
};

render() {
const {
action,
anchorOrigin: { vertical, horizontal },
autoHideDuration,
children,
classes,
className,
ClickAwayListenerProps,
ContentProps,
disableWindowBlurListener,
innerRef,
message,
onClose,
onEnter,
onEntered,
onEntering,
onExit,
onExited,
onExiting,
onMouseEnter,
onMouseLeave,
open,
resumeHideDuration,
TransitionComponent,
transitionDuration,
TransitionProps,
...other
} = this.props;
const handleMouseLeave = event => {
if (onMouseLeave) {
onMouseLeave(event);
}
handleResume();
};

// So we only render active snackbars.
if (!open && this.state.exited) {
return null;
const handleClickAway = event => {
if (onClose) {
onClose(event, 'clickaway');
}
};

return (
<ClickAwayListener onClickAway={this.handleClickAway} {...ClickAwayListenerProps}>
<div
className={clsx(
classes.root,
classes[`anchorOrigin${capitalize(vertical)}${capitalize(horizontal)}`],
className,
)}
onMouseEnter={this.handleMouseEnter}
onMouseLeave={this.handleMouseLeave}
ref={innerRef}
{...other}
>
<EventListener
target="window"
onFocus={disableWindowBlurListener ? undefined : this.handleResume}
onBlur={disableWindowBlurListener ? undefined : this.handlePause}
/>
<TransitionComponent
appear
in={open}
onEnter={onEnter}
onEntered={onEntered}
onEntering={onEntering}
onExit={onExit}
onExited={createChainedFunction(this.handleExited, onExited)}
onExiting={onExiting}
timeout={transitionDuration}
direction={vertical === 'top' ? 'down' : 'up'}
{...TransitionProps}
>
{children || <SnackbarContent message={message} action={action} {...ContentProps} />}
</TransitionComponent>
</div>
</ClickAwayListener>
);
const handleExited = () => {
setExited(true);
};

const handleEnter = () => {
setExited(false);
};

// So we only render active snackbars.
if (!open && exited) {
return null;
}
}

return (
<ClickAwayListener onClickAway={handleClickAway} {...ClickAwayListenerProps}>
<div
className={clsx(
classes.root,
classes[`anchorOrigin${capitalize(vertical)}${capitalize(horizontal)}`],
className,
)}
onMouseEnter={handleMouseEnter}
onMouseLeave={handleMouseLeave}
ref={ref}
{...other}
>
<EventListener
target="window"
onFocus={disableWindowBlurListener ? undefined : handleResume}
onBlur={disableWindowBlurListener ? undefined : handlePause}
/>
<TransitionComponent
appear
in={open}
onEnter={createChainedFunction(handleEnter, onEnter)}
onEntered={onEntered}
onEntering={onEntering}
onExit={onExit}
onExited={createChainedFunction(handleExited, onExited)}
onExiting={onExiting}
timeout={transitionDuration}
direction={vertical === 'top' ? 'down' : 'up'}
{...TransitionProps}
>
{children || <SnackbarContent message={message} action={action} {...ContentProps} />}
</TransitionComponent>
</div>
</ClickAwayListener>
);
});

Snackbar.propTypes = {
/**
Expand Down Expand Up @@ -315,11 +290,6 @@ Snackbar.propTypes = {
* If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
*/
disableWindowBlurListener: PropTypes.bool,
/**
* @ignore
* from `withForwardRef`
*/
innerRef: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
/**
* When displaying multiple consecutive Snackbars from a parent rendering a single
* <Snackbar/>, add the key property to ensure independent treatment of each message.
Expand Down Expand Up @@ -416,4 +386,4 @@ Snackbar.defaultProps = {
},
};

export default withStyles(styles, { flip: false, name: 'MuiSnackbar' })(withForwardedRef(Snackbar));
export default withStyles(styles, { flip: false, name: 'MuiSnackbar' })(Snackbar);