393 lines
10 KiB
Plaintext
393 lines
10 KiB
Plaintext
// @flow
|
|
|
|
import React from 'react';
|
|
import type { ComponentType, Element, Node } from 'react';
|
|
import classNames from 'classnames';
|
|
import EventListener from 'react-event-listener';
|
|
import withStyles from '../styles/withStyles';
|
|
import { duration } from '../styles/transitions';
|
|
import ClickAwayListener from '../utils/ClickAwayListener';
|
|
import { capitalizeFirstLetter, createChainedFunction } from '../utils/helpers';
|
|
import Slide from '../transitions/Slide';
|
|
import SnackbarContent from './SnackbarContent';
|
|
import type { TransitionDuration, TransitionCallback } from '../internal/transition';
|
|
|
|
export const styles = (theme: Object) => {
|
|
const gutter = theme.spacing.unit * 3;
|
|
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 {
|
|
root: {
|
|
zIndex: theme.zIndex.snackbar,
|
|
position: 'fixed',
|
|
display: 'flex',
|
|
left: 0,
|
|
right: 0,
|
|
justifyContent: 'center',
|
|
alignItems: 'center',
|
|
},
|
|
anchorTopCenter: {
|
|
extend: [top],
|
|
[theme.breakpoints.up('md')]: {
|
|
extend: [center],
|
|
},
|
|
},
|
|
anchorBottomCenter: {
|
|
extend: [bottom],
|
|
[theme.breakpoints.up('md')]: {
|
|
extend: [center],
|
|
},
|
|
},
|
|
anchorTopRight: {
|
|
extend: [top, right],
|
|
[theme.breakpoints.up('md')]: {
|
|
left: 'auto',
|
|
extend: [topSpace, rightSpace],
|
|
},
|
|
},
|
|
anchorBottomRight: {
|
|
extend: [bottom, right],
|
|
[theme.breakpoints.up('md')]: {
|
|
left: 'auto',
|
|
extend: [bottomSpace, rightSpace],
|
|
},
|
|
},
|
|
anchorTopLeft: {
|
|
extend: [top, left],
|
|
[theme.breakpoints.up('md')]: {
|
|
right: 'auto',
|
|
extend: [topSpace, leftSpace],
|
|
},
|
|
},
|
|
anchorBottomLeft: {
|
|
extend: [bottom, left],
|
|
[theme.breakpoints.up('md')]: {
|
|
right: 'auto',
|
|
extend: [bottomSpace, leftSpace],
|
|
},
|
|
},
|
|
};
|
|
};
|
|
|
|
export type Origin = {
|
|
horizontal?: 'left' | 'center' | 'right' | number,
|
|
vertical?: 'top' | 'center' | 'bottom' | number,
|
|
};
|
|
|
|
type ProvidedProps = {
|
|
anchorOrigin: Origin,
|
|
classes: Object,
|
|
};
|
|
|
|
export type Props = {
|
|
/**
|
|
* The action to display.
|
|
*/
|
|
action?: Node,
|
|
/**
|
|
* The anchor of the `Snackbar`.
|
|
*/
|
|
anchorOrigin?: Origin,
|
|
/**
|
|
* The number of milliseconds to wait before automatically dismissing.
|
|
* This behavior is disabled by default with the `null` value.
|
|
*/
|
|
autoHideDuration?: ?number,
|
|
/**
|
|
* 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?: number,
|
|
/**
|
|
* If you wish the take control over the children of the component you can use that property.
|
|
* When using it, no `SnackbarContent` component will be rendered.
|
|
*/
|
|
children?: Element<any>,
|
|
/**
|
|
* Useful to extend the style applied to components.
|
|
*/
|
|
classes?: Object,
|
|
/**
|
|
* @ignore
|
|
*/
|
|
className?: string,
|
|
/**
|
|
* 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?: any,
|
|
/**
|
|
* The message to display.
|
|
*/
|
|
message?: Node,
|
|
/**
|
|
* Callback fired before the transition is entering.
|
|
*/
|
|
onEnter?: TransitionCallback,
|
|
/**
|
|
* Callback fired when the transition is entering.
|
|
*/
|
|
onEntering?: TransitionCallback,
|
|
/**
|
|
* Callback fired when the transition has entered.
|
|
*/
|
|
onEntered?: TransitionCallback,
|
|
/**
|
|
* Callback fired before the transition is exiting.
|
|
*/
|
|
onExit?: TransitionCallback,
|
|
/**
|
|
* Callback fired when the transition is exiting.
|
|
*/
|
|
onExiting?: TransitionCallback,
|
|
/**
|
|
* Callback fired when the transition has exited.
|
|
*/
|
|
onExited?: TransitionCallback,
|
|
/**
|
|
* @ignore
|
|
*/
|
|
onMouseEnter?: Function,
|
|
/**
|
|
* @ignore
|
|
*/
|
|
onMouseLeave?: Function,
|
|
/**
|
|
* Callback fired when the component requests to be closed.
|
|
*
|
|
* Typically `onRequestClose` 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 `onRequestClose`,
|
|
* for example ignoring `clickaway`.
|
|
*
|
|
* @param {object} event The event source of the callback
|
|
* @param {string} reason Can be:`"timeout"` (`autoHideDuration` expired) or: `"clickaway"`
|
|
*/
|
|
onRequestClose?: (event: ?Event, reason: string) => void,
|
|
/**
|
|
* If true, `Snackbar` is open.
|
|
*/
|
|
open: boolean,
|
|
/**
|
|
* Properties applied to the `SnackbarContent` element.
|
|
*/
|
|
SnackbarContentProps?: Object,
|
|
/**
|
|
* Transition component.
|
|
*/
|
|
transition?: ComponentType<*>,
|
|
/**
|
|
* The duration for the transition, in milliseconds.
|
|
* You may specify a single timeout for all transitions, or individually with an object.
|
|
*/
|
|
transitionDuration?: TransitionDuration,
|
|
};
|
|
|
|
type State = {
|
|
exited: boolean,
|
|
};
|
|
|
|
class Snackbar extends React.Component<ProvidedProps & Props, State> {
|
|
static defaultProps = {
|
|
anchorOrigin: { vertical: 'bottom', horizontal: 'center' },
|
|
transitionDuration: {
|
|
enter: duration.enteringScreen,
|
|
exit: duration.leavingScreen,
|
|
},
|
|
};
|
|
|
|
state = {
|
|
// Used to only render active snackbars.
|
|
exited: false,
|
|
};
|
|
|
|
componentWillMount() {
|
|
if (!this.props.open) {
|
|
this.setState({ exited: true });
|
|
}
|
|
}
|
|
|
|
componentDidMount() {
|
|
if (this.props.open) {
|
|
this.setAutoHideTimer();
|
|
}
|
|
}
|
|
|
|
componentWillReceiveProps(nextProps) {
|
|
if (nextProps.open && this.state.exited) {
|
|
this.setState({ exited: false });
|
|
}
|
|
}
|
|
|
|
componentDidUpdate(prevProps) {
|
|
if (prevProps.open !== this.props.open) {
|
|
if (this.props.open) {
|
|
this.setAutoHideTimer();
|
|
} else {
|
|
clearTimeout(this.timerAutoHide);
|
|
}
|
|
}
|
|
}
|
|
|
|
componentWillUnmount() {
|
|
clearTimeout(this.timerAutoHide);
|
|
}
|
|
|
|
// Timer that controls delay before snackbar auto hides
|
|
setAutoHideTimer(autoHideDuration = null) {
|
|
if (!this.props.onRequestClose || this.props.autoHideDuration === undefined) {
|
|
return;
|
|
}
|
|
|
|
clearTimeout(this.timerAutoHide);
|
|
this.timerAutoHide = setTimeout(() => {
|
|
if (!this.props.onRequestClose || this.props.autoHideDuration === undefined) {
|
|
return;
|
|
}
|
|
|
|
this.props.onRequestClose(null, 'timeout');
|
|
}, autoHideDuration || this.props.autoHideDuration || 0);
|
|
}
|
|
|
|
timerAutoHide = null;
|
|
|
|
handleMouseEnter = (event: SyntheticUIEvent<>) => {
|
|
if (this.props.onMouseEnter) {
|
|
this.props.onMouseEnter(event);
|
|
}
|
|
this.handlePause();
|
|
};
|
|
|
|
handleMouseLeave = (event: SyntheticUIEvent<>) => {
|
|
if (this.props.onMouseLeave) {
|
|
this.props.onMouseLeave(event);
|
|
}
|
|
this.handleResume();
|
|
};
|
|
|
|
handleClickAway = (event: Event) => {
|
|
if (this.props.onRequestClose) {
|
|
this.props.onRequestClose(event, 'clickaway');
|
|
}
|
|
};
|
|
|
|
// Pause the timer when the user is interacting with the Snackbar
|
|
// or when the user hide the window.
|
|
handlePause = () => {
|
|
clearTimeout(this.timerAutoHide);
|
|
};
|
|
|
|
// 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 !== undefined) {
|
|
if (this.props.resumeHideDuration !== undefined) {
|
|
this.setAutoHideTimer(this.props.resumeHideDuration);
|
|
return;
|
|
}
|
|
this.setAutoHideTimer((this.props.autoHideDuration || 0) * 0.5);
|
|
}
|
|
};
|
|
|
|
handleTransitionExited = () => {
|
|
this.setState({ exited: true });
|
|
};
|
|
|
|
render() {
|
|
const {
|
|
action,
|
|
anchorOrigin: { vertical, horizontal },
|
|
autoHideDuration,
|
|
resumeHideDuration,
|
|
children,
|
|
classes,
|
|
className,
|
|
transitionDuration,
|
|
message,
|
|
onEnter,
|
|
onEntering,
|
|
onEntered,
|
|
onExit,
|
|
onExiting,
|
|
onExited,
|
|
onMouseEnter,
|
|
onMouseLeave,
|
|
onRequestClose,
|
|
open,
|
|
SnackbarContentProps,
|
|
transition: TransitionProp,
|
|
...other
|
|
} = this.props;
|
|
|
|
if (!open && this.state.exited) {
|
|
return null;
|
|
}
|
|
|
|
const transitionProps = {
|
|
in: open,
|
|
appear: true,
|
|
timeout: transitionDuration,
|
|
onEnter,
|
|
onEntering,
|
|
onEntered,
|
|
onExit,
|
|
onExiting,
|
|
onExited: createChainedFunction(this.handleTransitionExited, onExited),
|
|
};
|
|
const transitionContent = children || (
|
|
<SnackbarContent message={message} action={action} {...SnackbarContentProps} />
|
|
);
|
|
|
|
let transition;
|
|
if (TransitionProp) {
|
|
transition = <TransitionProp {...transitionProps}>{transitionContent}</TransitionProp>;
|
|
} else {
|
|
transition = (
|
|
<Slide direction={vertical === 'top' ? 'down' : 'up'} {...transitionProps}>
|
|
{transitionContent}
|
|
</Slide>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<EventListener target="window" onFocus={this.handleResume} onBlur={this.handlePause}>
|
|
<ClickAwayListener onClickAway={this.handleClickAway}>
|
|
<div
|
|
className={classNames(
|
|
classes.root,
|
|
classes[
|
|
`anchor${capitalizeFirstLetter(vertical)}${capitalizeFirstLetter(horizontal)}`
|
|
],
|
|
className,
|
|
)}
|
|
onMouseEnter={this.handleMouseEnter}
|
|
onMouseLeave={this.handleMouseLeave}
|
|
{...other}
|
|
>
|
|
{transition}
|
|
</div>
|
|
</ClickAwayListener>
|
|
</EventListener>
|
|
);
|
|
}
|
|
}
|
|
|
|
export default withStyles(styles, { flip: false, name: 'MuiSnackbar' })(Snackbar);
|