@material-ui/core
Version:
React components that implement Google's Material Design.
440 lines (381 loc) • 12.1 kB
JavaScript
import _extends from "@babel/runtime/helpers/extends";
import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
import _objectSpread from "@babel/runtime/helpers/objectSpread";
import React from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';
import EventListener from 'react-event-listener';
import withStyles from '../styles/withStyles';
import { duration } from '../styles/transitions';
import ClickAwayListener from '../ClickAwayListener';
import { capitalize, createChainedFunction } from '../utils/helpers';
import Slide from '../Slide';
import SnackbarContent from '../SnackbarContent';
export const styles = theme => {
const gutter = 24;
const top = {
top: 0
};
const bottom = {
bottom: 0
};
const right = {
justifyContent: 'flex-end'
};
const left = {
justifyContent: 'flex-start'
};
const topSpace = {
top: gutter
};
const bottomSpace = {
bottom: gutter
};
const rightSpace = {
right: gutter
};
const leftSpace = {
left: gutter
};
const center = {
left: '50%',
right: 'auto',
transform: 'translateX(-50%)'
};
return {
/* Styles applied to the root element. */
root: {
zIndex: theme.zIndex.snackbar,
position: 'fixed',
display: 'flex',
left: 0,
right: 0,
justifyContent: 'center',
alignItems: 'center'
},
/* Styles applied to the root element if `anchorOrigin={{ 'top', 'center' }}`. */
anchorOriginTopCenter: _objectSpread({}, top, {
[theme.breakpoints.up('md')]: _objectSpread({}, center)
}),
/* Styles applied to the root element if `anchorOrigin={{ 'bottom', 'center' }}`. */
anchorOriginBottomCenter: _objectSpread({}, bottom, {
[theme.breakpoints.up('md')]: _objectSpread({}, center)
}),
/* Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }}`. */
anchorOriginTopRight: _objectSpread({}, top, right, {
[theme.breakpoints.up('md')]: _objectSpread({
left: 'auto'
}, topSpace, rightSpace)
}),
/* Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }}`. */
anchorOriginBottomRight: _objectSpread({}, bottom, right, {
[theme.breakpoints.up('md')]: _objectSpread({
left: 'auto'
}, bottomSpace, rightSpace)
}),
/* Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }}`. */
anchorOriginTopLeft: _objectSpread({}, top, left, {
[theme.breakpoints.up('md')]: _objectSpread({
right: 'auto'
}, topSpace, leftSpace)
}),
/* Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }}`. */
anchorOriginBottomLeft: _objectSpread({}, bottom, left, {
[theme.breakpoints.up('md')]: _objectSpread({
right: 'auto'
}, bottomSpace, leftSpace)
})
};
};
/* istanbul ignore if */
if (process.env.NODE_ENV !== 'production' && !React.createContext) {
throw new Error('Material-UI: react@16.3.0 or greater is required.');
}
class Snackbar extends React.Component {
constructor(...args) {
super(...args);
this.state = {};
this.handleMouseEnter = event => {
if (this.props.onMouseEnter) {
this.props.onMouseEnter(event);
}
this.handlePause();
};
this.handleMouseLeave = event => {
if (this.props.onMouseLeave) {
this.props.onMouseLeave(event);
}
this.handleResume();
};
this.handleClickAway = event => {
if (this.props.onClose) {
this.props.onClose(event, 'clickaway');
}
};
this.handlePause = () => {
clearTimeout(this.timerAutoHide);
};
this.handleResume = () => {
if (this.props.autoHideDuration != null) {
if (this.props.resumeHideDuration != null) {
this.setAutoHideTimer(this.props.resumeHideDuration);
return;
}
this.setAutoHideTimer(this.props.autoHideDuration * 0.5);
}
};
this.handleExited = () => {
this.setState({
exited: true
});
};
}
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;
} // 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;
}
clearTimeout(this.timerAutoHide);
this.timerAutoHide = setTimeout(() => {
const autoHideDurationAfter = autoHideDuration != null ? autoHideDuration : this.props.autoHideDuration;
if (!this.props.onClose || autoHideDurationAfter == null) {
return;
}
this.props.onClose(null, 'timeout');
}, autoHideDurationBefore);
}
render() {
const _this$props = this.props,
{
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
} = _this$props,
other = _objectWithoutProperties(_this$props, ["action", "anchorOrigin", "autoHideDuration", "children", "classes", "className", "ClickAwayListenerProps", "ContentProps", "disableWindowBlurListener", "message", "onClose", "onEnter", "onEntered", "onEntering", "onExit", "onExited", "onExiting", "onMouseEnter", "onMouseLeave", "open", "resumeHideDuration", "TransitionComponent", "transitionDuration", "TransitionProps"]); // So we only render active snackbars.
if (!open && this.state.exited) {
return null;
}
return React.createElement(ClickAwayListener, _extends({
onClickAway: this.handleClickAway
}, ClickAwayListenerProps), React.createElement("div", _extends({
className: classNames(classes.root, classes[`anchorOrigin${capitalize(vertical)}${capitalize(horizontal)}`], className),
onMouseEnter: this.handleMouseEnter,
onMouseLeave: this.handleMouseLeave
}, other), React.createElement(EventListener, {
target: "window",
onFocus: disableWindowBlurListener ? undefined : this.handleResume,
onBlur: disableWindowBlurListener ? undefined : this.handlePause
}), React.createElement(TransitionComponent, _extends({
appear: true,
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 || React.createElement(SnackbarContent, _extends({
message: message,
action: action
}, ContentProps)))));
}
}
Snackbar.propTypes = process.env.NODE_ENV !== "production" ? {
/**
* The action to display.
*/
action: PropTypes.node,
/**
* The anchor of the `Snackbar`.
*/
anchorOrigin: PropTypes.shape({
horizontal: PropTypes.oneOf(['left', 'center', 'right']).isRequired,
vertical: PropTypes.oneOf(['top', 'center', 'bottom']).isRequired
}),
/**
* The number of milliseconds to wait before automatically calling the
* `onClose` function. `onClose` should then set the state of the `open`
* prop to hide the Snackbar. This behavior is disabled by default with
* the `null` value.
*/
autoHideDuration: PropTypes.number,
/**
* If you wish the take control over the children of the component you can use this property.
* When used, you replace the `SnackbarContent` component with the children.
*/
children: PropTypes.element,
/**
* Override or extend the styles applied to the component.
* See [CSS API](#css-api) below for more details.
*/
classes: PropTypes.object.isRequired,
/**
* @ignore
*/
className: PropTypes.string,
/**
* Properties applied to the `ClickAwayListener` element.
*/
ClickAwayListenerProps: PropTypes.object,
/**
* Properties applied to the [`SnackbarContent`](/api/snackbar-content/) element.
*/
ContentProps: PropTypes.object,
/**
* If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
*/
disableWindowBlurListener: PropTypes.bool,
/**
* When displaying multiple consecutive Snackbars from a parent rendering a single
* <Snackbar/>, add the key property to ensure independent treatment of each message.
* e.g. <Snackbar key={message} />, otherwise, the message may update-in-place and
* features such as autoHideDuration may be canceled.
*/
key: PropTypes.any,
/**
* The message to display.
*/
message: PropTypes.node,
/**
* Callback fired when the component requests to be closed.
* Typically `onClose` is used to set state in the parent component,
* which is used to control the `Snackbar` `open` prop.
* The `reason` parameter can optionally be used to control the response to `onClose`,
* for example ignoring `clickaway`.
*
* @param {object} event The event source of the callback
* @param {string} reason Can be:`"timeout"` (`autoHideDuration` expired) or: `"clickaway"`
*/
onClose: PropTypes.func,
/**
* Callback fired before the transition is entering.
*/
onEnter: PropTypes.func,
/**
* Callback fired when the transition has entered.
*/
onEntered: PropTypes.func,
/**
* Callback fired when the transition is entering.
*/
onEntering: PropTypes.func,
/**
* Callback fired before the transition is exiting.
*/
onExit: PropTypes.func,
/**
* Callback fired when the transition has exited.
*/
onExited: PropTypes.func,
/**
* Callback fired when the transition is exiting.
*/
onExiting: PropTypes.func,
/**
* @ignore
*/
onMouseEnter: PropTypes.func,
/**
* @ignore
*/
onMouseLeave: PropTypes.func,
/**
* If true, `Snackbar` is open.
*/
open: PropTypes.bool,
/**
* The number of milliseconds to wait before dismissing after user interaction.
* If `autoHideDuration` property isn't specified, it does nothing.
* If `autoHideDuration` property is specified but `resumeHideDuration` isn't,
* we default to `autoHideDuration / 2` ms.
*/
resumeHideDuration: PropTypes.number,
/**
* Transition component.
*/
TransitionComponent: PropTypes.oneOfType([PropTypes.string, PropTypes.func, PropTypes.object]),
/**
* The duration for the transition, in milliseconds.
* You may specify a single timeout for all transitions, or individually with an object.
*/
transitionDuration: PropTypes.oneOfType([PropTypes.number, PropTypes.shape({
enter: PropTypes.number,
exit: PropTypes.number
})]),
/**
* Properties applied to the `Transition` element.
*/
TransitionProps: PropTypes.object
} : {};
Snackbar.defaultProps = {
anchorOrigin: {
vertical: 'bottom',
horizontal: 'center'
},
disableWindowBlurListener: false,
TransitionComponent: Slide,
transitionDuration: {
enter: duration.enteringScreen,
exit: duration.leavingScreen
}
};
export default withStyles(styles, {
flip: false,
name: 'MuiSnackbar'
})(Snackbar);