130 lines
4.4 KiB
Plaintext
130 lines
4.4 KiB
Plaintext
'use client';
|
|
|
|
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
import * as React from 'react';
|
|
import { unstable_useEventCallback as useEventCallback, unstable_useTimeout as useTimeout } from '@mui/utils';
|
|
import { extractEventHandlers } from '../utils/extractEventHandlers';
|
|
/**
|
|
* The basic building block for creating custom snackbar.
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Snackbar](https://mui.com/base-ui/react-snackbar/#hook)
|
|
*
|
|
* API:
|
|
*
|
|
* - [useSnackbar API](https://mui.com/base-ui/react-snackbar/hooks-api/#use-snackbar)
|
|
*/
|
|
export function useSnackbar(parameters = {}) {
|
|
const {
|
|
autoHideDuration = null,
|
|
disableWindowBlurListener = false,
|
|
onClose,
|
|
open,
|
|
resumeHideDuration
|
|
} = parameters;
|
|
const timerAutoHide = useTimeout();
|
|
React.useEffect(() => {
|
|
if (!open) {
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* @param {KeyboardEvent} nativeEvent
|
|
*/
|
|
function handleKeyDown(nativeEvent) {
|
|
if (!nativeEvent.defaultPrevented) {
|
|
// IE11, Edge (prior to using Blink?) use 'Esc'
|
|
if (nativeEvent.key === 'Escape' || nativeEvent.key === 'Esc') {
|
|
// not calling `preventDefault` since we don't know if people may ignore this event e.g. a permanently open snackbar
|
|
onClose?.(nativeEvent, 'escapeKeyDown');
|
|
}
|
|
}
|
|
}
|
|
document.addEventListener('keydown', handleKeyDown);
|
|
return () => {
|
|
document.removeEventListener('keydown', handleKeyDown);
|
|
};
|
|
}, [open, onClose]);
|
|
const handleClose = useEventCallback((event, reason) => {
|
|
onClose?.(event, reason);
|
|
});
|
|
const setAutoHideTimer = useEventCallback(autoHideDurationParam => {
|
|
if (!onClose || autoHideDurationParam == null) {
|
|
return;
|
|
}
|
|
timerAutoHide.start(autoHideDurationParam, () => {
|
|
handleClose(null, 'timeout');
|
|
});
|
|
});
|
|
React.useEffect(() => {
|
|
if (open) {
|
|
setAutoHideTimer(autoHideDuration);
|
|
}
|
|
return timerAutoHide.clear;
|
|
}, [open, autoHideDuration, setAutoHideTimer, timerAutoHide]);
|
|
const handleClickAway = event => {
|
|
onClose?.(event, 'clickaway');
|
|
};
|
|
|
|
// Pause the timer when the user is interacting with the Snackbar
|
|
// or when the user hide the window.
|
|
const handlePause = timerAutoHide.clear;
|
|
|
|
// Restart the timer when the user is no longer interacting with the Snackbar
|
|
// or when the window is shown back.
|
|
const handleResume = React.useCallback(() => {
|
|
if (autoHideDuration != null) {
|
|
setAutoHideTimer(resumeHideDuration != null ? resumeHideDuration : autoHideDuration * 0.5);
|
|
}
|
|
}, [autoHideDuration, resumeHideDuration, setAutoHideTimer]);
|
|
const createHandleBlur = otherHandlers => event => {
|
|
const onBlurCallback = otherHandlers.onBlur;
|
|
onBlurCallback?.(event);
|
|
handleResume();
|
|
};
|
|
const createHandleFocus = otherHandlers => event => {
|
|
const onFocusCallback = otherHandlers.onFocus;
|
|
onFocusCallback?.(event);
|
|
handlePause();
|
|
};
|
|
const createMouseEnter = otherHandlers => event => {
|
|
const onMouseEnterCallback = otherHandlers.onMouseEnter;
|
|
onMouseEnterCallback?.(event);
|
|
handlePause();
|
|
};
|
|
const createMouseLeave = otherHandlers => event => {
|
|
const onMouseLeaveCallback = otherHandlers.onMouseLeave;
|
|
onMouseLeaveCallback?.(event);
|
|
handleResume();
|
|
};
|
|
React.useEffect(() => {
|
|
// TODO: window global should be refactored here
|
|
if (!disableWindowBlurListener && open) {
|
|
window.addEventListener('focus', handleResume);
|
|
window.addEventListener('blur', handlePause);
|
|
return () => {
|
|
window.removeEventListener('focus', handleResume);
|
|
window.removeEventListener('blur', handlePause);
|
|
};
|
|
}
|
|
return undefined;
|
|
}, [disableWindowBlurListener, open, handleResume, handlePause]);
|
|
const getRootProps = (externalProps = {}) => {
|
|
const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
|
|
return _extends({
|
|
// ClickAwayListener adds an `onClick` prop which results in the alert not being announced.
|
|
// See https://github.com/mui/material-ui/issues/29080
|
|
role: 'presentation'
|
|
}, externalProps, externalEventHandlers, {
|
|
onBlur: createHandleBlur(externalEventHandlers),
|
|
onFocus: createHandleFocus(externalEventHandlers),
|
|
onMouseEnter: createMouseEnter(externalEventHandlers),
|
|
onMouseLeave: createMouseLeave(externalEventHandlers)
|
|
});
|
|
};
|
|
return {
|
|
getRootProps,
|
|
onClickAway: handleClickAway
|
|
};
|
|
} |