@elastic/eui
Version:
Elastic UI Component Library
306 lines (299 loc) • 16.2 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.TOAST_FADE_OUT_MS = exports.SIDES = exports.EuiGlobalToastList = exports.CLEAR_ALL_TOASTS_THRESHOLD_DEFAULT = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
var _react = _interopRequireWildcard(require("react"));
var _classnames = _interopRequireDefault(require("classnames"));
var _common = require("../common");
var _services = require("../../services");
var _time = require("../../services/time");
var _global_toast_list_item = require("./global_toast_list_item");
var _toast = require("./toast");
var _global_toast_list = require("./global_toast_list.styles");
var _button = require("../button");
var _i18n = require("../i18n");
var _badge = require("../badge");
var _react2 = require("@emotion/react");
var _excluded = ["className", "toasts", "dismissToast", "toastLifeTimeMs", "onClearAllToasts", "side", "showClearAllButtonAt", "showNotificationBadge"],
_excluded2 = ["text", "toastLifeTimeMs"];
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
var sideToClassNameMap = {
left: 'euiGlobalToastList--left',
right: 'euiGlobalToastList--right'
};
var SIDES = exports.SIDES = (0, _common.keysOf)(sideToClassNameMap);
var TOAST_FADE_OUT_MS = exports.TOAST_FADE_OUT_MS = 250;
var CLEAR_ALL_TOASTS_THRESHOLD_DEFAULT = exports.CLEAR_ALL_TOASTS_THRESHOLD_DEFAULT = 3;
var EuiGlobalToastList = exports.EuiGlobalToastList = function EuiGlobalToastList(_ref) {
var className = _ref.className,
_ref$toasts = _ref.toasts,
toasts = _ref$toasts === void 0 ? [] : _ref$toasts,
dismissToastProp = _ref.dismissToast,
toastLifeTimeMs = _ref.toastLifeTimeMs,
onClearAllToasts = _ref.onClearAllToasts,
_ref$side = _ref.side,
side = _ref$side === void 0 ? 'right' : _ref$side,
_ref$showClearAllButt = _ref.showClearAllButtonAt,
showClearAllButtonAt = _ref$showClearAllButt === void 0 ? CLEAR_ALL_TOASTS_THRESHOLD_DEFAULT : _ref$showClearAllButt,
_ref$showNotification = _ref.showNotificationBadge,
showNotificationBadge = _ref$showNotification === void 0 ? false : _ref$showNotification,
rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
var _useState = (0, _react.useState)({}),
_useState2 = (0, _slicedToArray2.default)(_useState, 2),
toastIdToDismissedMap = _useState2[0],
setToastIdToDismissedMap = _useState2[1];
var _useState3 = (0, _react.useState)([]),
_useState4 = (0, _slicedToArray2.default)(_useState3, 2),
toastsToDismiss = _useState4[0],
setToastsToDismiss = _useState4[1];
var prevToasts = (0, _react.useRef)([]);
var dismissTimeoutIds = (0, _react.useRef)([]);
var toastIdToTimerMap = (0, _react.useRef)({});
var isScrollingToBottom = (0, _react.useRef)(false);
var isScrolledToBottom = (0, _react.useRef)(true);
var isUserInteracting = (0, _react.useRef)(false);
// See [Return Value](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestAnimationFrame#Return_value)
// for information on initial value of 0
var isScrollingAnimationFrame = (0, _react.useRef)(0);
var startScrollingAnimationFrame = (0, _react.useRef)(0);
var listElement = (0, _react.useRef)(null);
var styles = (0, _services.useEuiMemoizedStyles)(_global_toast_list.euiGlobalToastListStyles);
var cssStyles = [styles.euiGlobalToastList, styles[side]];
var startScrollingToBottom = (0, _react.useCallback)(function () {
isScrollingToBottom.current = true;
var scrollToBottom = function scrollToBottom() {
// Although we cancel the requestAnimationFrame in componentWillUnmount,
// it's possible for this.listElement to become null in the meantime
if (!listElement.current) {
return;
}
var position = listElement.current.scrollTop;
var destination = listElement.current.scrollHeight - listElement.current.clientHeight;
var distanceToDestination = destination - position;
if (distanceToDestination < 5) {
listElement.current.scrollTop = destination;
isScrollingToBottom.current = false;
isScrolledToBottom.current = true;
return;
}
listElement.current.scrollTop = position + distanceToDestination * 0.25;
if (isScrollingToBottom) {
isScrollingAnimationFrame.current = window.requestAnimationFrame(scrollToBottom);
}
};
startScrollingAnimationFrame.current = window.requestAnimationFrame(scrollToBottom);
}, []);
var onMouseEnter = (0, _react.useCallback)(function () {
// Stop scrolling to bottom if we're in mid-scroll, because the user wants to interact with
// the list.
isScrollingToBottom.current = false;
isUserInteracting.current = true;
// Don't let toasts dismiss themselves while the user is interacting with them.
for (var _toastId in toastIdToTimerMap.current) {
if (toastIdToTimerMap.current.hasOwnProperty(_toastId)) {
var timer = toastIdToTimerMap.current[_toastId];
timer.pause();
}
}
}, []);
var onMouseLeave = (0, _react.useCallback)(function () {
isUserInteracting.current = false;
for (var _toastId2 in toastIdToTimerMap.current) {
if (toastIdToTimerMap.current.hasOwnProperty(_toastId2)) {
var timer = toastIdToTimerMap.current[_toastId2];
timer.resume();
}
}
}, []);
var onScroll = (0, _react.useCallback)(function () {
// Given that this method also gets invoked by the synthetic scroll that happens when a new toast gets added,
// we want to evaluate if the scroll bottom has been reached only when the user is interacting with the toast,
// this way we always retain the scroll position the user has set despite adding in new toasts.
// User interaction is determined through the handler registered for mouseEnter and mouseLeave events.
if (listElement.current && isUserInteracting.current) {
isScrolledToBottom.current = listElement.current.scrollHeight - listElement.current.scrollTop === listElement.current.clientHeight;
}
}, []);
var dismissToast = (0, _react.useCallback)(function (toast) {
// Remove the toast after it's done fading out.
dismissTimeoutIds.current.push(window.setTimeout(function () {
setToastsToDismiss(function (toasts) {
return [].concat((0, _toConsumableArray2.default)(toasts), [toast]);
});
}, TOAST_FADE_OUT_MS));
setToastIdToDismissedMap(function (prev) {
return _objectSpread(_objectSpread({}, prev), {}, (0, _defineProperty2.default)({}, toast.id, true));
});
}, []);
var scheduleToastForDismissal = (0, _react.useCallback)(function (toast) {
// Start fading the toast out once its lifetime elapses.
toastIdToTimerMap.current[toast.id] = new _time.Timer(function () {
return dismissToast(toast);
}, toast.toastLifeTimeMs != null ? toast.toastLifeTimeMs : toastLifeTimeMs);
}, [dismissToast, toastLifeTimeMs]);
var scheduleAllToastsForDismissal = (0, _react.useCallback)(function () {
toasts.forEach(function (toast) {
if (!toastIdToTimerMap.current[toast.id]) {
scheduleToastForDismissal(toast);
}
});
}, [scheduleToastForDismissal, toasts]);
// componentDidMount
(0, _react.useEffect)(function () {
var listenerEl = listElement.current;
if (listenerEl) {
listenerEl.addEventListener('scroll', onScroll);
listenerEl.addEventListener('mouseenter', onMouseEnter);
listenerEl.addEventListener('mouseleave', onMouseLeave);
}
// componentWillUnmount
return function () {
if (listenerEl) {
listenerEl.removeEventListener('scroll', onScroll);
listenerEl.removeEventListener('mouseenter', onMouseEnter);
listenerEl.removeEventListener('mouseleave', onMouseLeave);
}
if (isScrollingAnimationFrame.current !== 0) {
window.cancelAnimationFrame(isScrollingAnimationFrame.current);
}
if (startScrollingAnimationFrame.current !== 0) {
window.cancelAnimationFrame(startScrollingAnimationFrame.current);
}
dismissTimeoutIds.current.forEach(clearTimeout); // eslint-disable-line react-hooks/exhaustive-deps
for (var _toastId3 in toastIdToTimerMap.current) {
if (toastIdToTimerMap.current.hasOwnProperty(_toastId3)) {
var timer = toastIdToTimerMap.current[_toastId3]; // eslint-disable-line react-hooks/exhaustive-deps
timer.clear();
}
}
};
}, [onMouseEnter, onMouseLeave, onScroll]);
// componentDidUpdate
(0, _react.useEffect)(function () {
scheduleAllToastsForDismissal();
if (!isUserInteracting.current) {
// If the user has scrolled up the toast list then we don't want to annoy them by scrolling
// all the way back to the bottom.
if (isScrolledToBottom.current) {
if (prevToasts.current.length < toasts.length) {
startScrollingToBottom();
}
}
}
prevToasts.current = toasts;
}, [toasts, scheduleAllToastsForDismissal, startScrollingToBottom]);
// Toast dismissal side effect
// Ensure the callback has correct state by not enclosing it in `setTimeout`
(0, _react.useEffect)(function () {
toastsToDismiss.forEach(function (toast) {
// Because this is triggered by a setTimeout, and because React does not guarantee when
// state updates happen, it is possible to double-dismiss a toast
// including by double-clicking the "x" button on the toast
// so, first check to make sure we haven't already dismissed this toast
if (toast && toastIdToTimerMap.current.hasOwnProperty(toast.id)) {
dismissToastProp(toast);
toastIdToTimerMap.current[toast.id].clear();
delete toastIdToTimerMap.current[toast.id];
setToastIdToDismissedMap(function (prev) {
var toastIdToDismissedMap = _objectSpread({}, prev);
delete toastIdToDismissedMap[toast.id];
return toastIdToDismissedMap;
});
}
});
}, [toastsToDismiss, dismissToastProp]);
var renderedToasts = (0, _react.useMemo)(function () {
return toasts.map(function (toast) {
var text = toast.text,
perToastLifeTimeMs = toast.toastLifeTimeMs,
rest = (0, _objectWithoutProperties2.default)(toast, _excluded2);
var effectiveLifeTimeMs = perToastLifeTimeMs !== null && perToastLifeTimeMs !== void 0 ? perToastLifeTimeMs : toastLifeTimeMs;
var onClose = function onClose() {
return dismissToast(toast);
};
return (0, _react2.jsx)(_global_toast_list_item.EuiGlobalToastListItem, {
key: toast.id,
isDismissed: toastIdToDismissedMap[toast.id]
}, (0, _react2.jsx)(_toast.EuiToast, (0, _extends2.default)({
onClose: onClose,
onFocus: onMouseEnter,
onBlur: onMouseLeave
}, rest, {
animationMs: effectiveLifeTimeMs,
text: text
})));
});
}, [toasts, toastIdToDismissedMap, dismissToast, onMouseEnter, onMouseLeave, toastLifeTimeMs]);
var clearAllButton = (0, _react.useMemo)(function () {
if (toasts.length && showClearAllButtonAt && toasts.length >= showClearAllButtonAt) {
return (0, _react2.jsx)(_i18n.EuiI18n, {
key: "euiClearAllToasts",
tokens: ['euiGlobalToastList.clearAllToastsButtonAriaLabel', 'euiGlobalToastList.clearAllToastsButtonDisplayText'],
defaults: ['Clear all toast notifications', 'Clear all']
}, function (_ref2) {
var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
clearAllToastsButtonAriaLabel = _ref3[0],
clearAllToastsButtonDisplayText = _ref3[1];
return (0, _react2.jsx)(_global_toast_list_item.EuiGlobalToastListItem, {
isDismissed: false
}, (0, _react2.jsx)(_button.EuiButton, {
fullWidth: true,
size: "s",
color: "text",
onClick: function onClick() {
toasts.forEach(function (toast) {
return dismissToastProp(toast);
});
onClearAllToasts === null || onClearAllToasts === void 0 || onClearAllToasts();
},
css: styles.euiGlobalToastListDismissButton,
"aria-label": clearAllToastsButtonAriaLabel,
"data-test-subj": "euiClearAllToastsButton"
}, clearAllToastsButtonDisplayText));
});
}
}, [showClearAllButtonAt, onClearAllToasts, toasts, dismissToastProp, styles]);
var classes = (0, _classnames.default)('euiGlobalToastList', className);
var hasContent = renderedToasts.length > 0 || clearAllButton != null;
var notificationBadge = (0, _react.useMemo)(function () {
var _toastIdToDismissedMa, _toasts$;
var toastWasDismissed = (_toastIdToDismissedMa = toastIdToDismissedMap[(_toasts$ = toasts[0]) === null || _toasts$ === void 0 ? void 0 : _toasts$.id]) !== null && _toastIdToDismissedMa !== void 0 ? _toastIdToDismissedMa : false;
var isListEmpty = toasts.every(function (t) {
return toastIdToDismissedMap[t.id];
});
return showNotificationBadge && toasts.length > 0 && (0, _react2.jsx)(_badge.EuiNotificationBadge, {
className: "euiGlobalToastList__countBadge",
css: [styles.notificationBadge.notificationBadge, toastWasDismissed && styles.notificationBadge.hasFadeOut, isListEmpty && styles.notificationBadge.hasFadeOut, ";label:notificationBadge;"],
size: "m",
color: "subdued",
"data-test-subj": "euiGlobalToastListNotificationBadge"
}, toasts.length);
}, [showNotificationBadge, toasts, toastIdToDismissedMap, styles]);
return (0, _react2.jsx)("div", (0, _extends2.default)({
"aria-live": "polite",
role: "log",
ref: listElement,
css: cssStyles,
className: classes
}, rest), hasContent && (0, _react2.jsx)("div", {
css: styles.content
}, notificationBadge, renderedToasts, clearAllButton));
};